One line description of your module
Project description
python3-pip-skeleton-cli provides the documentation and a command line tool to enable the adoption of python3-pip-skeleton into a new or existing Python project.
PyPI |
pip install python3-pip-skeleton |
Source code |
https://github.com/DiamondLightSource/python3-pip-skeleton-cli |
Documentation |
https://DiamondLightSource.github.io/python3-pip-skeleton-cli |
Releases |
https://github.com/DiamondLightSource/python3-pip-skeleton-cli/releases |
The related python3-pip-skeleton repository contains the source code that can be merged into new or existing projects, and pulled from to keep them up to date. It can also serve as a working example for those who would prefer to cherry-pick.
python3-pip-skeleton is inspired by jaraco/skeleton. It provides a generic Python project structure and allows developers to keep tools and techniques in sync between multiple Python projects. It integrates the following tools:
pip and setuptools_scm for version management
Pre-commit with black, flake8 and isort for static analysis
Pytest for code and coverage
Sphinx for tutorials, how-to guides, explanations and reference documentation
GitHub Actions for code and docs CI and deployment to PyPI and GitHub Pages
tox -p: runs pre-commit, pytest, mypy and make docs - which verifies all the things that CI does
If you use VSCode, it will run black, flake8, isort and mypy on save
Quick start
To create a new project based on skeleton:
python3-pip-skeleton new /path/to/be/created --org my_github_user_or_org
or to adopt skeleton into existing projects:
python3-pip-skeleton existing /path/to/existing/repo --org my_github_user_or_org
See https://DiamondLightSource.github.io/python3-pip-skeleton-cli for more detailed documentation.
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 python3-pip-skeleton-3.5.0.tar.gz
.
File metadata
- Download URL: python3-pip-skeleton-3.5.0.tar.gz
- Upload date:
- Size: 90.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3549a07a4e4d5f8b6f568632fbc10950c128305be7431ca2e6e3555d39864787 |
|
MD5 | e21f17e23de245eb62d4342383ab99fd |
|
BLAKE2b-256 | f15d8d03ff3cc332498d4cf071a62990297a08b9d9f5a99287ee0988bbfc94b3 |
File details
Details for the file python3_pip_skeleton-3.5.0-py3-none-any.whl
.
File metadata
- Download URL: python3_pip_skeleton-3.5.0-py3-none-any.whl
- Upload date:
- Size: 16.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25b0d611c587b8e035fcce3cde33aee61b46f830388269bf65bac8a157fc1397 |
|
MD5 | 705201ea4c2f5ebfd617f75de159ff73 |
|
BLAKE2b-256 | 5b05775efa9ef96bec1aef75f9377194c299b1e74ba004b6795cb1eeb549fa42 |