Metadata-Version: 2.1
Name: salduba_poetry_sample
Version: 0.1.0
Summary: 
License: LICENSE
Author: Miguel Pinilla
Author-email: miguel.pinilla@saldubatech.com
Requires-Python: >=3.11,<4.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Typing :: Typed
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Description-Content-Type: text/markdown

# Sample Python configuration with Poetry

## Badges

### Github Actions

[![GitHub Actions Status](https://github.com/pytest-dev/pytest-cov/actions/workflows/test.yml/badge.svg)](https://github.com/salduba/poetry-sample/actions)

## Guides

- [Warning for whomebrew](https://stackoverflow.com/questions/73365780/why-is-not-recommended-to-install-poetry-with-homebrew)
- [Poetry](https://python-poetry.org/)
- [Good initial set up](https://mitelman.engineering/blog/python-best-practice/automating-python-best-practices-for-a-new-project/)
- [CLI with poetry](https://dev.to/bowmanjd/build-command-line-tools-with-python-poetry-4mnc)
- [Poetry with Click](https://dev.to/bowmanjd/build-a-command-line-interface-with-python-poetry-and-click-1f5k)
- [Poetry + Click + Pipx](https://medium.com/clarityai-engineering/how-to-create-and-distribute-a-minimalist-cli-tool-with-python-poetry-click-and-pipx-c0580af4c026)
- [Packages vs Modules](https://dev.to/bowmanjd/python-module-vs-package-4m8e)
- [Packaging User Guide](https://packaging.python.org/en/latest/)
- [Poetry Build-Publish](https://www.freecodecamp.org/news/how-to-build-and-publish-python-packages-with-poetry/)
- [Poetry Credentials](https://python-poetry.org/docs/repositories/#configuring-credentials)

## Tools

### Pytest

- [Pytest Docs](https://docs.pytest.org/en/8.2.x/)

### Pytest-cov

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

### isort

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

- [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

### Flake8

- [Flake8 Linter](https://flake8.pycqa.org/en/latest/)

- Cannot be configured in `pyproject.toml`

### Black

- [Black Formatter](https://github.com/psf/black)
- [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

### Pre-commit

- [Pre-commit git hooks](https://pre-commit.com/)

## To explore

### Badges
- [Badges](https://shields.io/)
- [genbadge](https://smarie.github.io/python-genbadge/)
- [GHA Badges](https://github.com/marketplace/actions/coverage-badge)
- [GHA Badges 2]()
- [Coverage](https://github.com/dbrgn/coverage-badge)
