Template Repository for Python Scripts

A template repository for linting, testing, GUI building and dockerizing python scripts.

Checklist

• Replace YOURUSERNAME and IMAGENAME in .github/workflows/docker-image.yml [or delete file].
• Replace test data in data with your own data [or delete if you don't have test data].
• Adjust .gitattributes according to your needs.
• Adjust .gitignore according to your needs.
• Setup your CITATION.cff according to your needs [or delete file].
• Replace dummy values in Dockerfile and write image instructions.
• Replace copyright name in LICENSE.
• Replace lines 10 - 13 and write your script in main.py.
• Replace lines 10 - 13 and write your gui in gui/streamlit_app.py.
• Replace lines 3 - 6 and write tests in tests/test_main.py.
• Add your requirements to requirements.txt.
• Document your script using the numpydoc style and Sphinx:
  • Adjust the configuration to your needs in docs/conf.py.
  • Automatically via GitHub Actions:
    • In the repository go to Settings ➡️ Pages ➡️ Build and deployment ➡️ Source ➡️ GitHub Actions.
    • Select the gh-pages.yml / Deploy Documentation to Pages workflow.
  • Or build manually:
    • Install Sphinx and the PyData theme: pip install sphinx pydata-sphinx-theme.
    • Build documentation with:

      sphinx-apidoc -f -o docs .
      sphinx-build -b html docs html
      

    • Publish documentation [optional]!
    • Serving with GitHub pages needs the addition of an empty .nojekyll file to your /html.
• Adjust this README.md to your needs!

Known Issues

List of known issues

Citing

If you are using PLACEHOLDER script please cite:

Very important title
Important Author, and Another Important Author
Journal of Cool Stuff 2023 12 (3), 4567-4589
DOI: 12.3456/cool-stuff

License

• MIT

Contact

• micha.birklbauer@gmail.com