A serious Python project template for out-of-box and production usage.
Project description
Serious Scaffold Python
A serious Python project template for out-of-box and production usage.
Many efforts have been made to ease the project setup, but most of them are only language-specified basic components. In practice, we have to deal with much more details, especially for team projects. Many commonly used tools and configurations need to be handled properly. Moreover, different people tend to have different favors in various aspects. If you are tired of the inefficient setup process and endless discussion, Serious Scaffold Python is here to terminate those for Python Projects.
If you find this helpful, please consider sponsorship.
Features
- Basic Python project structure as a package with tests and documentation.
- Categorized requirements management with constraints for different environments.
typer
for CLI with tests and automatic documentation generation.pydantic
for settings with tests and documentation as module samples.setuptools-scm
to extract the version for the package.black
,isort
,mypy
,ruff
andtoml-sort
as linters.pre-commit
with general hooks and local linters.Makefile
as the entry point for common actions.- VSCode settings with recommended extensions.
- GitHub workflows for lint, tests, package and documentation preview.
Usage
-
Generate the project with the following command.
copier gh:huxuan/serious-scaffold-python /path/to/project
-
Initialize the project with git.
cd /path/to/project && git init
-
Happy hacking.
Roadmap
- More detailed documentation for all aspects.
- GitHub Dependabot integration.
- GitHub issue and pull request templates.
- Gitlab CI/CD integration.
- Gitlab issue and merge request templates.
License
MIT
Contributing
Any suggestions, discussions and bug fixing are all welcome.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for serious_scaffold-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d402a737c629392f120ce8bf8529ba0d07f762fa0ed7bab61f632af341bd2c46 |
|
MD5 | 999f7126859ed729a22b1465c4676250 |
|
BLAKE2b-256 | 5936715a3cc41d40c2d2ce36cc762c1e23bb6cd2bf946c2115ac24122b2fcd8c |