aadityaravindran / ideal-python-project Goto Github PK

Ideal Python Project Structure taken from https://realpython.com/python-application-layouts/, https://realpython.com/python-modules-packages/, and https://realpython.com/run-python-scripts/.

Resource management taken from https://python-packaging.readthedocs.io/en/latest/everything.html, and https://packaging.python.org/en/latest/guides/using-manifest-in/

To run the scripts from the module,

1. cd <the folder containing the project>
2. pip install -e .
3. ring-lord

To run the module tests,

1. cd <the folder containing the project>
2. python3 setup.py test