GitHub demonstration for serious-scaffold-python.
Project description
SSP GH
GitHub demonstration for serious-scaffold-python.
[!WARNING] SSP GH is in the Alpha phase. Frequent changes and instability should be anticipated. Any feedback, comments, suggestions and contributions are welcome!
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 streamlines this process. Powered by copier
, 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.
🛠️ Features
- Project setup and template update with
copier
. - Manage virtual environments for development with
pipenv
. - Manage dependency with categorized requirements and constraints.
- Automate Git hooks with pre-commit hooks and local linters.
- Lint with
black
,isort
,mypy
,ruff
, andtoml-sort
. - Test with
pytest
andcoverage
for threshold and reports. - Document with
sphinx
, thefuro
theme, and mypy/coverage reports. - Version the package using git metadata with
setuptools-scm
. - Continuous Integration with GitHub Actions and GitLab CI/CD.
- Versioned documentation with Read the Docs integration.
- Develop Command Line Interfaces with
typer
. - Manage configurations with
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
to install and run them in isolated environments. Refer to pipx's installation instructions here. Once pipx
is set up, install the necessary tools using the following commands.
# Copier: Template rendering for projects.
pipx install copier
# Pipenv: Virtual environment and package manager for Python.
pipx install pipenv
# Pre-commit: Automates Git hooks for code quality checks.
pipx install pre-commit
🚀 Quickstart
-
Generate the project.
copier copy gh:serious-scaffold/serious-scaffold-python /path/to/project
-
Navigate to the project directory and initialize a git repository.
cd /path/to/project git init
-
Set up the development environment.
make dev
-
Commit the initialized project.
git add . git commit -m "Initialize from serious-scaffold-python."
-
That's it! Feel free to focus on the coding within
src
folder.
🛡 Badge
Badge for markdown:
[![Serious Scaffold Python](https://img.shields.io/endpoint?url=https://serious-scaffold.github.io/serious-scaffold-python/_static/badges/logo.json)](https://serious-scaffold.github.io/serious-scaffold-python)
Badge for restructuredtext:
.. image:: https://img.shields.io/endpoint?url=https://serious-scaffold.github.io/serious-scaffold-python/_static/badges/logo.json
:target: huxuan.github.io/ssp-gh
📜 License
MIT License, for more details, see the LICENSE file.
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
File details
Details for the file ssp-gh-0.0.1.tar.gz
.
File metadata
- Download URL: ssp-gh-0.0.1.tar.gz
- Upload date:
- Size: 31.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.12.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c845c1fbab8479adb1f84dbd923140dd9ec5ceada8219571608a749557957d22 |
|
MD5 | 5d8d8ff76e01e22c72d2863f685b5815 |
|
BLAKE2b-256 | 7e4e39eca899d9458cd2a2801ab5cf640c0c1b8f1d1709f8771314e543678d65 |
File details
Details for the file ssp_gh-0.0.1-py3-none-any.whl
.
File metadata
- Download URL: ssp_gh-0.0.1-py3-none-any.whl
- Upload date:
- Size: 6.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.12.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 62469a55a452bed15161f179fa4aa6392c4ed3cefe77577dc2dcfa97c72fe5f5 |
|
MD5 | 213739c26873b01bfd005673621ff249 |
|
BLAKE2b-256 | 00ac9f1092aba50f3f97796e4e6b7494f3c31c8741ab6e678f8cce7ecc676822 |