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

A template for Python projects with linter/formatter configuration
https://github.com/staticf0x/python-project-template

python template template-project

Last synced: 3 days ago
JSON representation

A template for Python projects with linter/formatter configuration

• Host: GitHub
• URL: https://github.com/staticf0x/python-project-template
• Owner: staticf0x
• License: mit
• Created: 2023-08-20T15:57:07.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-08-23T13:04:22.000Z (over 1 year ago)
• Last Synced: 2024-04-24T05:26:04.006Z (9 months ago)
• Topics: python, template, template-project
• Language: Python
• Homepage:
• Size: 10.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# python-project-template

This project serves as a basic [Poetry](https://github.com/python-poetry/poetry)

based Python 3.11 project.

Included:

- [tox](https://github.com/tox-dev/tox) configuration

    + [pytest](https://github.com/pytest-dev/pytest) with [pytest-cov](https://github.com/pytest-dev/pytest-cov)

    + [mypy](https://github.com/python/mypy)

    + [ruff](https://github.com/astral-sh/ruff)

    + [isort](https://github.com/PyCQA/isort)

    + [black](https://github.com/psf/black)

    + Using [tox-poetry](https://github.com/tkukushkin/tox-poetry) to install dependencies

      via Poetry

- Linter configuration

    + Line length set to 100 characters

    + flake8 config just to be sure (setup.cfg)

    + isort profile set to "black"

- Sample `app/` folder with `tests/`

- [pre-commit](https://github.com/pre-commit/pre-commit) config

- [EditorConfig](https://editorconfig.org/)

- [Coverage](https://coverage.readthedocs.io/en/6.5.0/config.html) config

- `.gitignore` for common Python related clutter

## How to start working on a project

- Install Poetry: `pip3 install --user poetry`

- (Optional) install pre-commit: `pip3 install --user pre-commit`

- Jump in the project folder

- Enter Poetry shell: `poetry shell`

- Install dependencies: `poetry install`

- Run tox: `tox` (or `tox -p` for parallel)

- Install pre-commit hooks: `pre-commit install`