feat: create a python cookiecutter

elixir-cloud-aai / cookiecutter-python

Cookiecutter template for creating a Python project with Poetry, including configurations for various project settings.

Apache License 2.0

0 stars 0 forks source link

Summary by Sourcery

This pull request introduces a Python Cookiecutter template for creating Python projects with Poetry. It includes detailed documentation, CI/CD configurations, pre-commit hooks, and various enhancements to streamline project setup and development.

New Features:

Introduced a Python Cookiecutter template for creating Python projects with Poetry, including configurations for various project settings.

Enhancements:

Updated README.md to include detailed instructions on installation, usage, configurations, and contributing guidelines.
Added a Makefile for common development tasks such as creating virtual environments, running tests, and generating documentation.
Included a comprehensive .pre-commit-config.yaml for pre-commit hooks to ensure code quality.
Added a .markdownlint.yaml configuration for consistent markdown formatting.
Implemented a post-generation script to handle optional file creation based on user input.
Configured Sphinx for documentation generation with a default theme and settings.

Build:

Added a .github/actions/setup/poetry/action.yaml for setting up Python and Poetry in GitHub Actions.
Included a .github/workflows/code_quality.yaml for running code quality checks using GitHub Actions.
Added a .github/workflows/code_test.yaml for running unit and integration tests with coverage reporting.
Configured a .github/workflows/docs.yaml for checking the documentation.
Included a .github/workflows/vulnerability.yaml for running security scans on code and dependencies.
Added a .github/workflows/release_pypi.yaml for publishing packages to PyPI upon release.

CI:

Configured GitHub Actions workflows for code quality, testing, documentation, and vulnerability checks.
Added a .github/workflows/pr_validation.yaml for validating pull requests, including semantic PR title checks and pre-commit hooks.

Documentation:

Updated README.md with badges, table of contents, and detailed sections on various configurations and usage.
Added a PULL_REQUEST_TEMPLATE.md to guide contributors on how to structure their pull requests.
Included a .readthedocs.yaml for configuring ReadTheDocs builds.

Tests:

Added integration and unit tests for the generated project structure.
Configured pytest and pytest-cov for running tests and generating coverage reports.

Chores:

Added a .github/ISSUE_TEMPLATE/general-purpose.md for standardizing issue reports.
Included a .yamllint.yaml for YAML linting configuration.

Reviewer's Guide by Sourcery

This pull request introduces a comprehensive Python cookiecutter template with extensive configurations for project setup, documentation, CI/CD workflows, testing, and code quality checks. It includes updates to existing files and the addition of new files to support these features.

File-Level Changes

Files	Changes
`{{ cookiecutter.project_name }}/README.md` `{{ cookiecutter.project_name }}/Makefile` `{{ cookiecutter.project_name }}/docs/source/conf.py` `{{ cookiecutter.project_name }}/.github/actions/setup/poetry/action.yaml` `{{ cookiecutter.project_name }}/.github/workflows/code_quality.yaml` `{{ cookiecutter.project_name }}/.github/workflows/pr_validation.yaml` `{{ cookiecutter.project_name }}/.github/workflows/code_test.yaml` `{{ cookiecutter.project_name }}/.github/workflows/update.yaml` `{{ cookiecutter.project_name }}/.github/workflows/docs.yaml` `{{ cookiecutter.project_name }}/.github/workflows/vulnerability.yaml` `{{ cookiecutter.project_name }}/.github/workflows/release_pypi.yaml` `{{ cookiecutter.project_name }}/.pre-commit-config.yaml` `{{ cookiecutter.project_name }}/.safety-policy.yml` `{{ cookiecutter.project_name }}/docs/make.bat` `{{ cookiecutter.project_name }}/docs/Makefile` `{{ cookiecutter.project_name }}/.readthedocs.yaml` `{{ cookiecutter.project_name }}/tests/test_integration/test_init.py` `{{ cookiecutter.project_name }}/tests/test_unit/test_init.py` `{{ cookiecutter.project_name }}/.yamllint.yaml` `{{ cookiecutter.project_name }}/{{ cookiecutter.project_slug }}/main.py`	Added new files and configurations for project setup, documentation, CI/CD workflows, testing, and code quality checks.
`README.md` `cookiecutter.json`	Updated existing files to include new instructions, configurations, and options for the cookiecutter template.
`{{ cookiecutter.project_slug }}/README.md` `{{ cookiecutter.project_slug }}/{{ cookiecutter.project_slug }}/main.py`	Deleted old files that are no longer needed.

Tips

- Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.

elixir-cloud-aai / cookiecutter-python