https://github.com/devdungeon/python-app-template
My app for CLI and PyQt5 based GUI applications
https://github.com/devdungeon/python-app-template
Last synced: 9 months ago
JSON representation
My app for CLI and PyQt5 based GUI applications
- Host: GitHub
- URL: https://github.com/devdungeon/python-app-template
- Owner: DevDungeon
- Created: 2020-01-28T07:03:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-02-25T02:16:22.000Z (over 6 years ago)
- Last Synced: 2025-01-20T00:53:41.522Z (over 1 year ago)
- Language: Python
- Size: 25.4 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# myapp
## Overview
This example project template was generated from
https://github.com/DevDungeon/Python-App-Template
The template aims to be a good starting place for
any kind of app you want to build with Python including
command-line and GUI applications.
## Documentation
Read the documentation online at
[http://myapp.rtfd.io/](http://myapp.rtfd.io/).
To build the documentation locally from the `docs/`
directory using `sphinx`, you can do so like this:
```bash
pip install sphinx
cd docs/
make html
```
To learn more about reStructuredText see:
https://www.devdungeon.com/content/restructuredtext-rst-tutorial-0
## Source code
The source code is available at:
https://github.com/DevDungeon/Python-App-Template
## Installing
You can install the library from source
by executing the `setup.py` file
from the root directory like this:
```bash
python3 setup.py install
```
You can also install from the Python Package Index (PyPI)
https://pypi.org/ using `pip` like this:
```bash
python3 -m pip install myapp
```
## Running
Once the package is installed, you can run it like this:
```bash
python -m myapp
# or
python -m myapp --gui
```
or like this, assuming your path is setup correctly
in your system or virtual environment:
```bash
myapp
# Or
mygui
```
## Using this library in Python code
```python
import mylib
mylib.MyClass().run()
```
## Version history
- 0.0.1 - Initial release
## Contact