This repo provides a scratch of a Python project. Its purpose is to serve as starting point for the development of a Python project based on a minimal working structure.
- A preconfigured setup.py file following the suggestions from here;
- Sphinx autodocumentation with autodoc;
- Travis CI minimal configuration;
- Tests with pytest;
- Hierarquical structure to a python package as suggested by "The Hitchhiker’s Guide to Python" (highly recommended reading);
- A Read The Docs configuration scratch.
Contributions are VERY welcome. But please be aware of the purpose of the repo: A minimal working structure. If you want to add a feature which is very particular to your needs, please analyse if it fits the objective.
Suggestions and advices are welcome as well.
One can contact me through the email volpatto@lncc.br.