{"id":18283721,"url":"https://github.com/scruffaluff/scaffold-python","last_synced_at":"2025-09-13T10:37:23.798Z","repository":{"id":105905424,"uuid":"243179686","full_name":"scruffaluff/scaffold-python","owner":"scruffaluff","description":"Template project for generating Python application repository layouts.","archived":false,"fork":false,"pushed_at":"2025-08-10T08:31:26.000Z","size":3784,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-10T10:18:58.797Z","etag":null,"topics":["cookiecutter","project-template","python","scaffolding"],"latest_commit_sha":null,"homepage":"https://scruffaluff.github.io/scaffold-python/","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/scruffaluff.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","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,"zenodo":null}},"created_at":"2020-02-26T05:50:51.000Z","updated_at":"2025-01-10T04:44:10.000Z","dependencies_parsed_at":"2024-05-10T05:21:25.131Z","dependency_job_id":"fbd62411-551c-47ce-b51a-7f3a3a6cef71","html_url":"https://github.com/scruffaluff/scaffold-python","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/scruffaluff/scaffold-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scruffaluff%2Fscaffold-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scruffaluff%2Fscaffold-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scruffaluff%2Fscaffold-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scruffaluff%2Fscaffold-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scruffaluff","download_url":"https://codeload.github.com/scruffaluff/scaffold-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scruffaluff%2Fscaffold-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274949606,"owners_count":25379455,"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","status":"online","status_checked_at":"2025-09-13T02:00:10.085Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","project-template","python","scaffolding"],"created_at":"2024-11-05T13:10:30.266Z","updated_at":"2025-09-13T10:37:23.774Z","avatar_url":"https://github.com/scruffaluff.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Scaffold Python\n\n![](https://github.com/scruffaluff/scaffold-python/workflows/build/badge.svg)\n![](https://img.shields.io/badge/code%20style-black-000000.svg)\n![](https://img.shields.io/github/repo-size/scruffaluff/scaffold-python)\n![](https://img.shields.io/github/license/scruffaluff/scaffold-python)\n\n---\n\n**Documentation**: https://scruffaluff.github.io/scaffold-python\n\n**Source Code**: https://github.com/scruffaluff/scaffold-python\n\n---\n\nScaffold Python is a\n[Cookiecutter](https://github.com/cookiecutter/cookiecutter) template project\nfor generating Python repository layouts. To create a new Python application\nproject with the template first install\n[Cookiecutter](https://github.com/cookiecutter/cookiecutter). Then execute\n\n```console\ncookiecutter https://github.com/scruffaluff/scaffold-python\n```\n\nFollow the interactive prompts, and a folder, with your selected `project_name`,\nwill be generated in your current working directory.\n\n## Setup\n\nTo develop with the generated project, install\n[Poetry](https://python-poetry.org/) and step into the project folder.\nAfterwards execute the following commands.\n\n```console\npoetry install\npoetry shell\nblack .\ngit init\n```\n\nThen the development environment is configured, and you are ready to code.\n\n## Tooling\n\nEvery generated project configures the following tools for development usage:\n\n- [Bandit](https://github.com/PyCQA/bandit): Security linter.\n- [Black](https://github.com/psf/black): Opinionated code formatter.\n- [Coverage](https://coverage.readthedocs.io/en/coverage-5.0.3/): Test coverage\n  measurer.\n- [Flake8](https://flake8.pycqa.org/en/latest/): Code linter.\n  - [Flake8 Bugbear](https://github.com/PyCQA/flake8-bugbear): Flake8 plugin for\n    finding bugs and design problems.\n  - [Flake8 Docstrings](https://gitlab.com/pycqa/flake8-docstrings): Flake8\n    plugin for checking docstring styles.\n  - [Flake8 Import Order](https://github.com/PyCQA/flake8-import-order): Flake8\n    plugin for checking module import orders.\n- [MkDocs](https://www.mkdocs.org/): Documentation static site generator.\n- [Mypy](http://mypy-lang.org/): Static type checker.\n- [Poetry](https://python-poetry.org/): Dependency manager and packager.\n- [Pytest](https://docs.pytest.org/en/latest/): Testing framework.\n- [Tox](https://tox.readthedocs.io/en/latest/): Test automator.\n\nThe following tools are configured if you select optional features:\n\n- `prettier_support`:\n  - [Prettier](https://prettier.io/): Opinionated code formatter for JSON,\n    Markdown, and YAML files. Requires [NodeJS](https://nodejs.org/en/) to be\n    externally installed on your system.\n\n## Layout\n\nThe following diagram shows all possible files generated from scaffolding. If a\nfile is followed by `{option: selection}`, then the path and its possible\ncontents are only generated for that chosen context.\n\n```\n{{project_name}}\n├── .github  {githost: github}\n│   └── workflows\n│       ├── build.yaml\n│       ├── pages.yaml\n│       └── release.yaml\n├── .dockerignore\n├── .gitignore\n├── .gitlab-ci.yaml  {githost: gitlab}\n├── .prettierignore  {prettier_support: yes}\n├── .prettierrc.yaml  {prettier_support: yes}\n├── CONTRIBUTING.md\n├── docs\n│   ├── api\n│   |   └── index.md\n│   └── usage\n│       └── index.md\n├── examples\n│   └── __init__.py\n├── LICENSE.md\n├── mkdocs.yml\n├── pyproject.toml\n├── README.md\n├── scripts\n│   ├── __init__.py\n│   ├── build_docs.py\n│   ├── setup_tmate.ps1  {githost: gitlab}\n│   └── setup_tmate.sh  {githost: gitlab}\n├── src\n│   └── {{project_slug}}\n│       ├── __init__.py\n│       ├── __main__.py  {cli_support: yes}\n│       └── py.typed\n├── tests\n│   ├── conftest.py\n│   ├── __init__.py\n└── tox.ini\n```\n\n## Continuous Integration\n\nProjects generated with this scaffolding repository are automatically configured\nto use GitHub CI workflows and GitLab CI pipelines.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscruffaluff%2Fscaffold-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscruffaluff%2Fscaffold-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscruffaluff%2Fscaffold-python/lists"}