{"id":24989134,"url":"https://github.com/engineervix/cookiecutter-pyproject","last_synced_at":"2025-03-29T11:40:43.580Z","repository":{"id":37036598,"uuid":"298886664","full_name":"engineervix/cookiecutter-pyproject","owner":"engineervix","description":"A simple Cookiecutter template to quickly bootstrap a new python project","archived":false,"fork":false,"pushed_at":"2024-11-25T23:51:57.000Z","size":288,"stargazers_count":0,"open_issues_count":78,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-12-06T20:57:04.115Z","etag":null,"topics":["cookiecutter","cookiecutter-template","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/engineervix.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-26T19:36:04.000Z","updated_at":"2022-01-09T08:36:08.000Z","dependencies_parsed_at":"2023-01-31T17:30:35.990Z","dependency_job_id":"9eb139f4-52af-44af-90e2-e484e5ab1929","html_url":"https://github.com/engineervix/cookiecutter-pyproject","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineervix%2Fcookiecutter-pyproject","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineervix%2Fcookiecutter-pyproject/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineervix%2Fcookiecutter-pyproject/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineervix%2Fcookiecutter-pyproject/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/engineervix","download_url":"https://codeload.github.com/engineervix/cookiecutter-pyproject/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246180898,"owners_count":20736459,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cookiecutter","cookiecutter-template","python"],"created_at":"2025-02-04T12:18:42.754Z","updated_at":"2025-03-29T11:40:43.187Z","avatar_url":"https://github.com/engineervix.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eWelcome to cookiecutter-pyproject 👋\u003c/h1\u003e\n\u003cp\u003e\n  \u003ca href=\"https://python3statement.org/#sections50-why\" target=\"_blank\"\u003e\n    \u003cimg alt=\"python3\" src=\"https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-brightgreen.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://circleci.com/gh/engineervix/cookiecutter-pyproject/tree/master\" target=\"_blank\"\u003e\n    \u003cimg alt=\"CircleCI\" src=\"https://circleci.com/gh/engineervix/cookiecutter-pyproject/tree/master.svg?style=svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://coveralls.io/github/engineervix/cookiecutter-pyproject?branch=master\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Coverage Status\" src=\"https://coveralls.io/repos/github/engineervix/cookiecutter-pyproject/badge.svg?branch=master\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/pre-commit/pre-commit\" target=\"_blank\"\u003e\n    \u003cimg alt=\"pre-commit\" src=\"https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/engineervix/cookiecutter-pyproject/graphs/commit-activity\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Maintenance\" src=\"https://img.shields.io/badge/Maintained%3F-yes-green.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://sonarcloud.io/dashboard?id=engineervix_cookiecutter-pyproject\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Maintainability Rating\" src=\"https://sonarcloud.io/api/project_badges/measure?project=engineervix_cookiecutter-pyproject\u0026metric=sqale_rating\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/engineervix/cookiecutter-pyproject/LICENSE\" target=\"_blank\"\u003e\n    \u003cimg alt=\"License: MIT\" src=\"https://img.shields.io/github/license/engineervix/cookiecutter-pyproject\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003cp\u003e\n  \u003ca href=\"https://requires.io/github/engineervix/cookiecutter-pyproject/requirements/?branch=master\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Requirements Status\" src=\"https://requires.io/github/engineervix/cookiecutter-pyproject/requirements.svg?branch=master\" /\u003e\n  \u003c/a\u003e\n  \u003c!-- \u003ca href=\"https://dependabot.com/\" target=\"_blank\"\u003e\n    \u003cimg alt=\"dependabot\" src=\"https://badgen.net/dependabot/engineervix/cookiecutter-pyproject/?icon=dependabot\" /\u003e\n  \u003c/a\u003e --\u003e\n  \u003ca href=\"https://github.com/PyCQA/bandit\" target=\"_blank\"\u003e\n    \u003cimg alt=\"security: bandit\" src=\"https://img.shields.io/badge/security-bandit-informational.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"http://commitizen.github.io/cz-cli/\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Commitizen friendly\" src=\"https://img.shields.io/badge/commitizen-friendly-brightgreen.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://conventionalcommits.org\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Conventional Commits\" src=\"https://img.shields.io/badge/Conventional%20Commits-1.0.0-informational.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://twitter.com/engineervix\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Twitter: engineervix\" src=\"https://img.shields.io/twitter/follow/engineervix.svg?style=social\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003e A simple Cookiecutter template to quickly bootstrap a new python project\n\n## Features\n\n- Always up-to-date dependencies with the help of [dependabot](https://dependabot.com/)\n- Python 3.6+\n- Testing using [`pytest`](https://docs.pytest.org/en/stable/)\n- Uses [pip-tools](https://github.com/jazzband/pip-tools) for dependency management\n- Continuous Integration options: [Gitlab CI](https://docs.gitlab.com/ee/ci/) or [Circle CI](https://circleci.com/)\n- Pre-commit hooks via [pre-commit](https://pre-commit.com/).\n- [Conventional commits](https://www.conventionalcommits.org/) courtesy of the [Commitizen tool](https://github.com/commitizen-tools/commitizen), which is also useful for:\n  - Bumping versions automatically using [semantic versioning](https://semver.org/) based on the commits\n  - Generating a changelog using [Keep a changelog](https://keepachangelog.com/)\n- Code formatting using [black](https://github.com/psf/black)\n- Linting using [flake8](https://flake8.pycqa.org/en/latest/)\n- Choice of various licenses\n- Optional CLI using [Click](https://click.palletsprojects.com/) or [argparse](https://docs.python.org/3/library/argparse.html)\n- Generates a simple [VSCode](https://code.visualstudio.com/) `settings.json` (Just change the `python.pythonPath`)\n\n## Getting started\n\nEnsure that you have [cookiecutter](https://github.com/audreyr/cookiecutter) installed on your computer:\n\n```sh\npip install -U cookiecutter\n```\n\nBootstrap your new python project:\n\n```sh\ncookiecutter https://github.com/engineervix/cookiecutter-pyproject.git\n```\n\nYou'll be prompted for some values, such as **project_name**, **project_slug**, **email**, **license**, etc.\n\nOnce you're done, `cd` into your the new project folder created above, and you're ready to roll :sunglasses:!\n\n### Other steps\n\n- Create a virtual environment for your project\n- Install project dependencies: `pip install -r requirements.txt`\n- `pre-commit install`\n- `pre-commit install --hook-type commit-msg`\n- add any additional requirements in the `requirements.in` file, then\n  - `pip-compile requirements.in` to generate an updated `requirements.txt` file\n  - `pip-sync` to update your virtual environment to reflect exactly what's in the `requirements.txt` file.\n\nIt goes without saying that you'll want to create a repo for your new project. If you're using *Circle CI*, ensure that you add your repo to your [CircleCI](https://circleci.com/) account. Optionally register your repo with [dependabot](https://app.dependabot.com/), [requires.io](https://requires.io), [coveralls](https://coveralls.io), [codeclimate](https://codeclimate.com/) and [deepsource](https://deepsource.io/) (Don't forget to add the Code Climate, Coveralls and Deepsource Environment Variables to your Project's Settings in your CircleCI Dashboard). If you don't want to use any of these services\n\n- remove them (coveralls, codeclimate and deepsource) from the CircleCI configuration file\n- remove the respective badges in your project's `README.md` file\n\n### Tests\n\nSimply run `pytest`. For more detailed output, including test coverage:\n\n```sh\npytest -vv --cov-config=.coveragerc --cov=. --cov-report term-missing\n```\n\n## Author\n\n👤 **Victor Miti**\n\n* Twitter: [@engineervix](https://twitter.com/engineervix)\n* Github: [@engineervix](https://github.com/engineervix)\n\n## 🤝 Contributing\n\nContributions, issues and feature requests are welcome!\u003cbr /\u003eFeel free to check [issues page](https://github.com/engineervix/cookiecutter-pyproject/issues).\n\n## Show your support\n\nGive a ⭐️ if this project helped you!\n\n## 📝 License\n\nCopyright © 2020 [Victor Miti](https://github.com/engineervix).\u003cbr /\u003e\nThis project is [MIT](https://github.com/engineervix/cookiecutter-pyproject/LICENSE) licensed.\n\n## Credits\n\nInspired by:\n\n- [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage)\n- [wemake-services/wemake-python-package](https://github.com/wemake-services/wemake-python-package)\n- [sourcery-ai/python-best-practices-cookiecutter](https://github.com/sourcery-ai/python-best-practices-cookiecutter)\n- [ionelmc/cookiecutter-pylibrary](https://github.com/ionelmc/cookiecutter-pylibrary)\n- [cjolowicz/cookiecutter-hypermodern-python](https://github.com/cjolowicz/cookiecutter-hypermodern-python)\n\n## FAQs\n\n- Why create another python **Cookiecutter** when there's already so many excellent ones (like the ones above)?\n\n\u003e I agree that there are several excellent python project cookiecutters out there. In fact, I wouldn't have written this version without the others (especially the ones in the Credits section above)! I am already used to a particular workflow, and I wanted a Cookiecutter that mirrors my workflow. None of the existing Cookiecutters were an exact fit, so I decided to write my own!\n\n## TODO\n\n- [ ] Add other CI options: [Github Actions](https://github.com/features/actions), [AppVeyor](https://www.appveyor.com/) and perhaps [Travis CI](https://travis-ci.org/)\n- [ ] Add [packaging](https://packaging.python.org/guides/distributing-packages-using-setuptools/) options\n- [ ] Include options for [coveralls](https://coveralls.io), [codeclimate](https://codeclimate.com/) and [deepsource](https://deepsource.io/) in Gitlab CI.\n- [ ] Working with [dependabot](https://dependabot.com/) on Gitlab\n- [ ] `Makefile` to automate some boring tasks and encapsulate long commands\n\n***\n_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fengineervix%2Fcookiecutter-pyproject","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fengineervix%2Fcookiecutter-pyproject","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fengineervix%2Fcookiecutter-pyproject/lists"}