chiplukes/python-example-application

example-python-application

[]

This is a simple project that can be used to start new python application.

Installation

Install this application using pip:

git clone git+https://github.com/chiplukes/python-example-application

Usage

• throughout project rename python-example-application with your actual hyphenated project name.
• throughout project rename python_example_application with your actual underscored project name.
• throughout project rename chiplukes with your actual github username.
• in source folder rename folders and files to match name of your application
  • if package does not include any submodules or extra python files, just delete those.
• add correct imports into relevant __init__.py files

Development

To use this application, first checkout the code. Then create a new virtual environment:

cd python-example-application
python -m venv .venv
source venv/bin/activate

Now install the dependencies and test dependencies:

python -m pip install -e .

Running main application

python -m python_example_application

To run the tests:

pip install -e '.[test]'
pytest

For using pre-commit hooks:

pre-commit install