https://github.com/skevo18/python-project-template

A template for new Python projects. Ready for pytest for tests, pdoc for automatic documentation from docstrings, setup.py and automatic tests on every push, automatic PyPI package publishing & documentation building via GH Pages on new releases.
https://github.com/skevo18/python-project-template

project python template

Last synced: about 1 month ago
JSON representation

A template for new Python projects. Ready for pytest for tests, pdoc for automatic documentation from docstrings, setup.py and automatic tests on every push, automatic PyPI package publishing & documentation building via GH Pages on new releases.

• Host: GitHub
• URL: https://github.com/skevo18/python-project-template
• Owner: SKevo18
• License: mit
• Created: 2021-12-20T15:06:47.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-10-28T15:56:27.000Z (about 2 years ago)
• Last Synced: 2023-04-02T12:24:55.519Z (over 1 year ago)
• Topics: project, python, template
• Language: Python
• Homepage:
• Size: 84 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Python project template

A template for new Python projects.

## Features

- Automatically builds [PDoc](https://pdoc3.github.io/pdoc/) documentation & uploads package to [PyPI](https://pypi.org) on new GitHub release, thanks to GitHub actions;

- Tests with pyTest before uploading to PyPI (or you can test manually with `workflow-dispatch`);

- Ready-to-go `setup.py` file;

- Scripts to build documentation and compile as a Python package;

- A to-do list below;

- Possibly more ;)

## Your to-do list

- [ ] Edit `# FIXME` lines to match your project;

  - [ ] setup.py

    - [ ] Package name

    - [ ] License

    - [ ] Version

    - [ ] Author

    - [ ] Author email

    - [ ] Description

    - [ ] Keywords

    - [ ] Classifiers

    - [ ] Repository URL

- [ ] Setup virtualenv (`scripts/setup_virtualenv_windows.ps1` for Windows);

- [ ] Rename `python_project_template` folder and start writing your source code;

- [ ] Add your dependencies to `requirements.txt`;

- [ ] Update .gitingore with your stuff;

- [ ] Replace this `README.md` file with a fancier one;

- [ ] Upload code to your GitHub repository;

- [ ] Turn on GitHub pages and use `documentation` as your pages branch;

- [ ] Add your editior to `.gitignore`;

- [ ] Add your PyPI API key to GitHub secrets (`PYPI_API_TOKEN`);

- [ ] When your are done, make a new release at GitHub to build documentation and upload to PyPI;

  - Don't forget to bump version in `setup.py` everytime you do a new release!!!

Generated documentation example: https://cwkevo.github.io/python-project-template

That should be it. Happy coding!

If you have any questions or found a bug, please open a new issue in this repository.