{"id":20590039,"url":"https://github.com/doist/cookiecutter-python-project","last_synced_at":"2025-07-20T11:34:05.694Z","repository":{"id":44656784,"uuid":"232274913","full_name":"Doist/cookiecutter-python-project","owner":"Doist","description":"Use this cookiecutter template 🍪 to start every new Python project at Doist","archived":false,"fork":false,"pushed_at":"2022-12-19T12:08:43.000Z","size":19,"stargazers_count":5,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-14T22:30:22.336Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/Doist.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}},"created_at":"2020-01-07T08:06:19.000Z","updated_at":"2021-01-16T19:08:00.000Z","dependencies_parsed_at":"2023-01-29T21:20:33.530Z","dependency_job_id":null,"html_url":"https://github.com/Doist/cookiecutter-python-project","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Doist/cookiecutter-python-project","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doist%2Fcookiecutter-python-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doist%2Fcookiecutter-python-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doist%2Fcookiecutter-python-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doist%2Fcookiecutter-python-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Doist","download_url":"https://codeload.github.com/Doist/cookiecutter-python-project/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doist%2Fcookiecutter-python-project/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266117909,"owners_count":23879145,"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":[],"created_at":"2024-11-16T07:33:43.235Z","updated_at":"2025-07-20T11:34:05.668Z","avatar_url":"https://github.com/Doist.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Starter Template for Python projects at Doist\n\nUse this cookiecutter template 🍪 to start every new Python project at Doist.\n\n## Getting Started\n\nNothing can be easier:\n\n```\ngit clone https://github.com/Doist/cookiecutter-python-project.git\ncookiecutter cookiecutter-python-project/\n```\n\nFor Windows, you might need to run `python -m cookiecutter` as the command might not work even though it's correctly configured on the PATH.\n\n## What's inside\n\nThe template covers your back with the following elements:\n\n- README.md with a pre-defined structure.\n- CHANGELOG.md file with an initial message.\n- Stub project template.\n- Test directory with a sample test file.\n- GitHub workflow configuration to run pytest automatically.\n- Pre-configured mypy, Flake8, isort.\n- A set of pre-commit hooks.\n- pyproject.toml for Poetry.\n\n## How to use it\n\nBefore creating a project:\n\n- Install [Poetry](https://python-poetry.org/docs/#installation)\n- Choose a project name. Likely, in the format `foo-bar` and create a GitHub\n  repository for it. The root package of your project will have a default\n  name `foo_bar`. Make sure that you made the repository private if you plan to create\n  a private (non-open-source) project.\n- Choose the license. For public projects use MIT, for private projects use\n  \"Proprietary\".\n\nAfter creating a project:\n\n- Initialize git repo with `git init`\n- Initialize your pre-commit hooks inside the repo with `pre-commit install`. For\n  more details follow https://pre-commit.com/\n- Initialize virtual environment and install all dependencies with `poetry install`\n- Add all files to the repo, review staged changes and commit them.\n- Deploy changes to GitHub.\n- For Windows, you might need to change your personal access token to GitHub, see information [here](https://github.com/gitextensions/gitextensions/issues/4916#issuecomment-557509451)\n\nOther hints:\n\n- Use [How to Write Good Documentation](https://www.sohamkamani.com/blog/how-to-write-good-documentation/)\n  to fill in our README with the content.\n- Use [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) guideline for your\n  changelog entries.\n  \n## How to configure VSCode\n\nAt the moment, VSCode doesn't automatically detect Poetry environments. You can set it \nmanually though. For a newly created project, create a `.vscode/settings.json`\n\n```\npoetry install\nmkdir -p .vscode\ncat \u003c\u003cEOF \u003e .vscode/settings.json\n{\n  \"python.pythonPath\": \"$(poetry env info -p)/bin/python\"\n}\nEOF\n```\n\nRef: https://github.com/microsoft/vscode-python/issues/8372\n\n## How to contribute\n\nWell, just create an issue or a pull request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoist%2Fcookiecutter-python-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoist%2Fcookiecutter-python-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoist%2Fcookiecutter-python-project/lists"}