# Serious Scaffold Python
A Python project template covering the entire development lifecycle with various integrations, configurations and modules.
[](https://github.com/serious-scaffold/ss-python/actions/workflows/ci.yml)
[](https://github.com/serious-scaffold/ss-python/actions/workflows/commitlint.yml)
[](https://github.com/serious-scaffold/ss-python/actions/workflows/devcontainer.yml)
[](https://github.com/serious-scaffold/ss-python/actions/workflows/release.yml)
[](https://github.com/serious-scaffold/ss-python/actions/workflows/renovate.yml)
[](https://serious-scaffold.github.io/ss-python/reports/coverage)
[](https://pypi.org/project/ss-python/)
[](https://pypi.org/project/ss-python/)
[](https://github.com/serious-scaffold/ss-python/blob/main/LICENSE)
[](https://github.com/pre-commit/pre-commit)
[](http://mypy-lang.org/)
[](https://github.com/astral-sh/ruff)
[](https://conventionalcommits.org)
[](https://pydantic.dev)
[](https://serious-scaffold.github.io/ss-python)
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/serious-scaffold/ss-python)
> [!WARNING]
> _Serious Scaffold Python_ is in the **Alpha** phase.
> Frequent changes and instability should be anticipated.
> Any feedback, comments, suggestions and contributions are welcome!
[](https://github.com/serious-scaffold/ss-python)
Setting up a project often involves more than just establishing a basic project structure. It involves tasks like integrating GitHub Actions or GitLab CI/CD, configuring lint, test and documentation, as well as implementing settings, logging and other frequently used modules. [Serious Scaffold Python](https://github.com/serious-scaffold/ss-python) streamlines this process. Powered by [`copier`](https://copier.readthedocs.io/), bootstrapping a new Python project can be done with a single command. By answering a few questions, the project will be fully configured and ready for development. Furthermore, the project can be updated alongside the advancement of the template.
If you find this helpful, please consider [sponsorship](https://github.com/sponsors/huxuan).
## 🛠️ Features
- Project setup and template update with [`copier`](https://copier.readthedocs.io/).
- Manage dependencies and virtual environments with [`pdm`](https://pdm-project.org/).
- Version the package using [dynamic SCM tag](https://backend.pdm-project.org/metadata/#read-from-scm-tag-supporting-git-and-hg) with [`pdm-backend`](https://backend.pdm-project.org/).
- Containerization for development and deployment with [dev container](https://containers.dev/).
- Automate dependency updates with [Renovate](https://github.com/renovatebot/renovate).
- Automate Git hooks with [pre-commit hooks](https://github.com/pre-commit/pre-commit-hooks) and [local](https://pre-commit.com/#repository-local-hooks) linters.
- Lint with [`mypy`](http://www.mypy-lang.org/), [`ruff`](https://github.com/charliermarsh/ruff), [`toml-sort`](https://github.com/pappasam/toml-sort) and [`commitlint`](https://commitlint.js.org/).
- Test with [`pytest`](https://pytest.org/) and [`coverage`](https://coverage.readthedocs.io) for threshold and reports.
- Documentation with [`sphinx`](https://www.sphinx-doc.org/), the [`furo`](https://pradyunsg.me/furo) theme, and [mypy](https://mypy.readthedocs.io/en/stable/command_line.html?report-generation)/[coverage](https://coverage.readthedocs.io/en/7.3.0/cmd.html#html-reporting-coverage-html) reports.
- Continuous Integration with [GitHub Actions](https://docs.github.com/actions) and [GitLab CI/CD](https://docs.gitlab.com/ee/ci/).
- Latest stable documentation published to [GitHub](https://docs.github.com/en/pages)/[GitLab](https://docs.gitlab.com/ee/user/project/pages/) Pages.
- [Versioned documentation](https://docs.readthedocs.io/en/stable/versions.html) and [pull request previews](https://docs.readthedocs.io/en/stable/pull-requests.html) with [Read the Docs](https://readthedocs.org/).
- Develop Command Line Interfaces with [`typer`](https://typer.tiangolo.com/).
- Manage configurations with [`pydantic-settings`](https://docs.pydantic.dev/latest/usage/pydantic_settings/).
- Centralize common actions with a unified Makefile.
- VSCode settings with recommended extensions.
## 🔧 Prerequisites
Certain system-level Python applications are needed and it is recommended to use [`pipx`](https://pypa.github.io/pipx/) to install and run them in isolated environments. Refer to pipx's installation instructions [here](https://pypa.github.io/pipx/installation/). Once `pipx` is set up, install the necessary tools using the following commands.
```bash
# Copier: Template rendering for projects.
pipx install copier
# PDM: A modern Python package and dependency manager supporting the latest PEP standards.
pipx install pdm
# Pre-commit: Automates Git hooks for code quality checks.
pipx install pre-commit
```
## 🚀 Quickstart
1. Generate the project.
```bash
copier copy gh:serious-scaffold/ss-python /path/to/project
```
2. Navigate to the project directory and initialize a git repository.
```bash
cd /path/to/project
git init
```
3. Set up the development environment.
```bash
make dev
```
4. Commit the initialized project.
```bash
git add .
git commit -m "Initialize from serious-scaffold."
```
5. That's it! Feel free to focus on the coding within `src` folder.
## 🛡 Badge
Badge for markdown:
```markdown
[](https://serious-scaffold.github.io/ss-python)
```
Badge for restructuredtext:
```restructuredtext
.. image:: https://img.shields.io/endpoint?url=https://serious-scaffold.github.io/ss-python/_static/badges/logo.json
:target: serious-scaffold.github.io/ss-python
```
It will look like this: [](https://serious-scaffold.github.io/ss-python)
## 📜 License
MIT License, for more details, see the [LICENSE](https://github.com/serious-scaffold/ss-python/blob/main/LICENSE) file.
Raw data
{
"_id": null,
"home_page": "https://github.com/serious-scaffold/ss-python/",
"name": "ss-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "copier-template full-development-lifecycle project-template serious-scaffold",
"author": null,
"author_email": "huxuan <i@huxuan.org>",
"download_url": "https://files.pythonhosted.org/packages/2c/1a/513f14ab88d34d047eef2eca4c3fcae9825df38cf70c829376be9b64619c/ss_python-0.0.50.tar.gz",
"platform": null,
"description": "# Serious Scaffold Python\n\nA Python project template covering the entire development lifecycle with various integrations, configurations and modules.\n\n[](https://github.com/serious-scaffold/ss-python/actions/workflows/ci.yml)\n[](https://github.com/serious-scaffold/ss-python/actions/workflows/commitlint.yml)\n[](https://github.com/serious-scaffold/ss-python/actions/workflows/devcontainer.yml)\n[](https://github.com/serious-scaffold/ss-python/actions/workflows/release.yml)\n[](https://github.com/serious-scaffold/ss-python/actions/workflows/renovate.yml)\n[](https://serious-scaffold.github.io/ss-python/reports/coverage)\n[](https://pypi.org/project/ss-python/)\n[](https://pypi.org/project/ss-python/)\n[](https://github.com/serious-scaffold/ss-python/blob/main/LICENSE)\n\n[](https://github.com/pre-commit/pre-commit)\n[](http://mypy-lang.org/)\n[](https://github.com/astral-sh/ruff)\n[](https://conventionalcommits.org)\n[](https://pydantic.dev)\n[](https://serious-scaffold.github.io/ss-python)\n[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/serious-scaffold/ss-python)\n\n> [!WARNING]\n> _Serious Scaffold Python_ is in the **Alpha** phase.\n> Frequent changes and instability should be anticipated.\n> Any feedback, comments, suggestions and contributions are welcome!\n\n[](https://github.com/serious-scaffold/ss-python)\n\nSetting up a project often involves more than just establishing a basic project structure. It involves tasks like integrating GitHub Actions or GitLab CI/CD, configuring lint, test and documentation, as well as implementing settings, logging and other frequently used modules. [Serious Scaffold Python](https://github.com/serious-scaffold/ss-python) streamlines this process. Powered by [`copier`](https://copier.readthedocs.io/), bootstrapping a new Python project can be done with a single command. By answering a few questions, the project will be fully configured and ready for development. Furthermore, the project can be updated alongside the advancement of the template.\n\nIf you find this helpful, please consider [sponsorship](https://github.com/sponsors/huxuan).\n\n## \ud83d\udee0\ufe0f Features\n\n- Project setup and template update with [`copier`](https://copier.readthedocs.io/).\n- Manage dependencies and virtual environments with [`pdm`](https://pdm-project.org/).\n- Version the package using [dynamic SCM tag](https://backend.pdm-project.org/metadata/#read-from-scm-tag-supporting-git-and-hg) with [`pdm-backend`](https://backend.pdm-project.org/).\n- Containerization for development and deployment with [dev container](https://containers.dev/).\n- Automate dependency updates with [Renovate](https://github.com/renovatebot/renovate).\n- Automate Git hooks with [pre-commit hooks](https://github.com/pre-commit/pre-commit-hooks) and [local](https://pre-commit.com/#repository-local-hooks) linters.\n- Lint with [`mypy`](http://www.mypy-lang.org/), [`ruff`](https://github.com/charliermarsh/ruff), [`toml-sort`](https://github.com/pappasam/toml-sort) and [`commitlint`](https://commitlint.js.org/).\n- Test with [`pytest`](https://pytest.org/) and [`coverage`](https://coverage.readthedocs.io) for threshold and reports.\n- Documentation with [`sphinx`](https://www.sphinx-doc.org/), the [`furo`](https://pradyunsg.me/furo) theme, and [mypy](https://mypy.readthedocs.io/en/stable/command_line.html?report-generation)/[coverage](https://coverage.readthedocs.io/en/7.3.0/cmd.html#html-reporting-coverage-html) reports.\n- Continuous Integration with [GitHub Actions](https://docs.github.com/actions) and [GitLab CI/CD](https://docs.gitlab.com/ee/ci/).\n- Latest stable documentation published to [GitHub](https://docs.github.com/en/pages)/[GitLab](https://docs.gitlab.com/ee/user/project/pages/) Pages.\n- [Versioned documentation](https://docs.readthedocs.io/en/stable/versions.html) and [pull request previews](https://docs.readthedocs.io/en/stable/pull-requests.html) with [Read the Docs](https://readthedocs.org/).\n- Develop Command Line Interfaces with [`typer`](https://typer.tiangolo.com/).\n- Manage configurations with [`pydantic-settings`](https://docs.pydantic.dev/latest/usage/pydantic_settings/).\n- Centralize common actions with a unified Makefile.\n- VSCode settings with recommended extensions.\n\n## \ud83d\udd27 Prerequisites\n\nCertain system-level Python applications are needed and it is recommended to use [`pipx`](https://pypa.github.io/pipx/) to install and run them in isolated environments. Refer to pipx's installation instructions [here](https://pypa.github.io/pipx/installation/). Once `pipx` is set up, install the necessary tools using the following commands.\n\n```bash\n# Copier: Template rendering for projects.\npipx install copier\n# PDM: A modern Python package and dependency manager supporting the latest PEP standards.\npipx install pdm\n# Pre-commit: Automates Git hooks for code quality checks.\npipx install pre-commit\n```\n\n## \ud83d\ude80 Quickstart\n\n1. Generate the project.\n\n ```bash\n copier copy gh:serious-scaffold/ss-python /path/to/project\n ```\n\n2. Navigate to the project directory and initialize a git repository.\n\n ```bash\n cd /path/to/project\n git init\n ```\n\n3. Set up the development environment.\n\n ```bash\n make dev\n ```\n\n4. Commit the initialized project.\n\n ```bash\n git add .\n git commit -m \"Initialize from serious-scaffold.\"\n ```\n\n5. That's it! Feel free to focus on the coding within `src` folder.\n\n## \ud83d\udee1 Badge\n\nBadge for markdown:\n\n```markdown\n[](https://serious-scaffold.github.io/ss-python)\n```\n\nBadge for restructuredtext:\n\n```restructuredtext\n.. image:: https://img.shields.io/endpoint?url=https://serious-scaffold.github.io/ss-python/_static/badges/logo.json\n :target: serious-scaffold.github.io/ss-python\n```\n\nIt will look like this: [](https://serious-scaffold.github.io/ss-python)\n\n## \ud83d\udcdc License\n\nMIT License, for more details, see the [LICENSE](https://github.com/serious-scaffold/ss-python/blob/main/LICENSE) file.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python project template covering the entire development lifecycle with various integrations, configurations and modules.",
"version": "0.0.50",
"project_urls": {
"Homepage": "https://github.com/serious-scaffold/ss-python/",
"Issue": "https://github.com/serious-scaffold/ss-python/issues"
},
"split_keywords": [
"copier-template",
"full-development-lifecycle",
"project-template",
"serious-scaffold"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ad3c085fae746388841014fecc4cd75da13a415d55d3f670f4fc8c88ba6e2ae7",
"md5": "2a17faae2a2db0b56fcf1da3617fcca1",
"sha256": "90b73f7daeb000471e156e60d6fd7a9d769a48f4b05e2710e502a92d0ecfe8cd"
},
"downloads": -1,
"filename": "ss_python-0.0.50-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2a17faae2a2db0b56fcf1da3617fcca1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6418,
"upload_time": "2024-03-25T06:05:09",
"upload_time_iso_8601": "2024-03-25T06:05:09.446084Z",
"url": "https://files.pythonhosted.org/packages/ad/3c/085fae746388841014fecc4cd75da13a415d55d3f670f4fc8c88ba6e2ae7/ss_python-0.0.50-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2c1a513f14ab88d34d047eef2eca4c3fcae9825df38cf70c829376be9b64619c",
"md5": "ab891b19e9b22a5ef808b56409192a40",
"sha256": "36f4aa6674b6545be599aec7496d2eb08656ba8a193009845be941b7252b9e5e"
},
"downloads": -1,
"filename": "ss_python-0.0.50.tar.gz",
"has_sig": false,
"md5_digest": "ab891b19e9b22a5ef808b56409192a40",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6220,
"upload_time": "2024-03-25T06:05:11",
"upload_time_iso_8601": "2024-03-25T06:05:11.271185Z",
"url": "https://files.pythonhosted.org/packages/2c/1a/513f14ab88d34d047eef2eca4c3fcae9825df38cf70c829376be9b64619c/ss_python-0.0.50.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-25 06:05:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "serious-scaffold",
"github_project": "ss-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ss-python"
}
JSON
