README.md

Python Project Template

Template for Python projects with Poetry, automation of semantic release with CI using GitHub Actions.

Summary

• Installation and usage
  • Installation
  • Run
• Configuration
• Contributing
• Change log
• License
• Credits

---

Installation and usage

Installation

pip3 install poetry

Run

poetry run python src/main.py

Configuration

You can set up a pyproject.toml file to set rules. This is useful to avoid reusing the same CLI flags over and over again and helps to define the structure of your project.

Example:

[tool.python-project-template]
variable = "samples"
list-of-variables = ["sample 1", "sample 2", "sample 3"]
boolean-variable = true

CLI flags always overwrite the config file.

Contributing

Thank you for considering making template better for everyone!

Refer to Contributing docs.

Change log

See CHANGELOG.

License

MIT

Credits

Thanks to guilatrova, and he's project called tryceratops for insights.