An open source framework for building desktop application..

About | Installation | Usage | Features | Author | Contributors | Help | License

About

Flatipie is now an unmaintained project. I'll continue developing this if I have encouraged to do so.

Flatipie is an open source framework use for deploying, building and creating desktop applications. It was created to build modern qt project easily and reliable.

Flatipie was originally developed to build desktop application easily using PyQt5 that also uses it's original stylesheet for creating modern application.

Installation

$ pip install flatipie

Usage

You can check out the main documentation

To create your first project, just kindly execute create command after you installed Flatipie and fill out any requirements used for packaging the project

$ flatipie create

You can run file that contains package.json just execute this following command

$ flatipie run

After you finish creating your app, you can easily build executable file for it with the following command. Make sure it contains package.json

$ flatipie build

Features

We also added alot of widgets/features for creating modern applications. Here are the list of widgets we customize

Button

"""
Following args for the button:

    Button(parent, string: str, color: QColor, font_color: QColor, outline: bool, shadow: bool)

You don't need to provide stylesheet for it, just pass in the arguments
in order to achieve your style.

"""
button = Button(self, "Get Started")
button.clicked.connect(lambda: print("Navigation"))

# Material Style

button = MaterialButton(self, QColor(77, 153, 239))
button.clicked.connect(lambda: print("Material Button"))

LineEdit

"""
LineEdits have 2 style, the first one is with background and second has no background
It's arguments is same as QLineEdit:
     LineEdit(parent, color: QColor, background: bool)
"""
line = LineEdit(self, color=QColor(77, 153, 239), background=True)

Clickable cards

"""
Clickable cards are similar to groupbox with clicking signals
and more effect. 

To connect clicked signals you may use this
"""
cards = MaterialCard(self, shadow=True)
cards.clicked.connect(lambda: print("Navigation"))

Sidebar

"""
The sidebar is based on QTabWidget.
"""


sidebar = Sidebar(self)
sidebar.addTab(QWidget(), QIcon("icon.png"))

For more information about custom widgets and samples, kindly proceed in this link

Help

Having troubles or issues regarding to this topic? Join our discord server and chat with others! You can also follow me on twitter

Author

Flatipie was created and maintained in 9th day of November, 2020.

flatipie	Zenqi

Contributors

License

Copyright (c) 2020 Flatipie

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.