README.md

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/.

To build the documentation locally from the docs/ directory using sphinx, you can do so like this:

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:

python3 setup.py install

You can also install from the Python Package Index (PyPI) https://pypi.org/ using pip like this:

python3 -m pip install myapp

Running

Once the package is installed, you can run it like this:

python -m myapp
# or
python -m myapp --gui

or like this, assuming your path is setup correctly in your system or virtual environment:

myapp
# Or
mygui

Using this library in Python code

import mylib
mylib.MyClass().run()

Version history

• 0.0.1 - Initial release

Contact