https://github.com/scruffaluff/scaffold-python
Template project for generating Python application repository layouts.
https://github.com/scruffaluff/scaffold-python
cookiecutter project-template python scaffolding
Last synced: 10 months ago
JSON representation
Template project for generating Python application repository layouts.
- Host: GitHub
- URL: https://github.com/scruffaluff/scaffold-python
- Owner: scruffaluff
- License: mit
- Created: 2020-02-26T05:50:51.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-08-10T08:31:26.000Z (12 months ago)
- Last Synced: 2025-08-10T10:18:58.797Z (12 months ago)
- Topics: cookiecutter, project-template, python, scaffolding
- Language: Python
- Homepage: https://scruffaluff.github.io/scaffold-python/
- Size: 3.61 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Scaffold Python
---
**Documentation**: https://scruffaluff.github.io/scaffold-python
**Source Code**: https://github.com/scruffaluff/scaffold-python
---
Scaffold Python is a
[Cookiecutter](https://github.com/cookiecutter/cookiecutter) template project
for generating Python repository layouts. To create a new Python application
project with the template first install
[Cookiecutter](https://github.com/cookiecutter/cookiecutter). Then execute
```console
cookiecutter https://github.com/scruffaluff/scaffold-python
```
Follow the interactive prompts, and a folder, with your selected `project_name`,
will be generated in your current working directory.
## Setup
To develop with the generated project, install
[Poetry](https://python-poetry.org/) and step into the project folder.
Afterwards execute the following commands.
```console
poetry install
poetry shell
black .
git init
```
Then the development environment is configured, and you are ready to code.
## Tooling
Every generated project configures the following tools for development usage:
- [Bandit](https://github.com/PyCQA/bandit): Security linter.
- [Black](https://github.com/psf/black): Opinionated code formatter.
- [Coverage](https://coverage.readthedocs.io/en/coverage-5.0.3/): Test coverage
measurer.
- [Flake8](https://flake8.pycqa.org/en/latest/): Code linter.
- [Flake8 Bugbear](https://github.com/PyCQA/flake8-bugbear): Flake8 plugin for
finding bugs and design problems.
- [Flake8 Docstrings](https://gitlab.com/pycqa/flake8-docstrings): Flake8
plugin for checking docstring styles.
- [Flake8 Import Order](https://github.com/PyCQA/flake8-import-order): Flake8
plugin for checking module import orders.
- [MkDocs](https://www.mkdocs.org/): Documentation static site generator.
- [Mypy](http://mypy-lang.org/): Static type checker.
- [Poetry](https://python-poetry.org/): Dependency manager and packager.
- [Pytest](https://docs.pytest.org/en/latest/): Testing framework.
- [Tox](https://tox.readthedocs.io/en/latest/): Test automator.
The following tools are configured if you select optional features:
- `prettier_support`:
- [Prettier](https://prettier.io/): Opinionated code formatter for JSON,
Markdown, and YAML files. Requires [NodeJS](https://nodejs.org/en/) to be
externally installed on your system.
## Layout
The following diagram shows all possible files generated from scaffolding. If a
file is followed by `{option: selection}`, then the path and its possible
contents are only generated for that chosen context.
```
{{project_name}}
├── .github {githost: github}
│ └── workflows
│ ├── build.yaml
│ ├── pages.yaml
│ └── release.yaml
├── .dockerignore
├── .gitignore
├── .gitlab-ci.yaml {githost: gitlab}
├── .prettierignore {prettier_support: yes}
├── .prettierrc.yaml {prettier_support: yes}
├── CONTRIBUTING.md
├── docs
│ ├── api
│ | └── index.md
│ └── usage
│ └── index.md
├── examples
│ └── __init__.py
├── LICENSE.md
├── mkdocs.yml
├── pyproject.toml
├── README.md
├── scripts
│ ├── __init__.py
│ ├── build_docs.py
│ ├── setup_tmate.ps1 {githost: gitlab}
│ └── setup_tmate.sh {githost: gitlab}
├── src
│ └── {{project_slug}}
│ ├── __init__.py
│ ├── __main__.py {cli_support: yes}
│ └── py.typed
├── tests
│ ├── conftest.py
│ ├── __init__.py
└── tox.ini
```
## Continuous Integration
Projects generated with this scaffolding repository are automatically configured
to use GitHub CI workflows and GitLab CI pipelines.