Automates the heavy lifting of release and distribution management for pure Python packages.
Project description
shut
Shut is an opinionated tool that allows you to configure everything around the Python packaging and release process from a single source of truth. It is intended to simplify the process of publishing Python packages and prevent common pitfalls.
At a glance
- Bootstrap Python packages:
shut pkg new --name my-package
- Install and save dependencies:
shut pkg requirements add <package>
- Document changes:
shut changelog --add fix --commit --message "Fixed `TypeError` in `foo()`"
- Bump the version according to changelog:
shut pkg bump --minor --tag --push
- Publish on PyPI:
shut pkg publish warehouse:pypi
Configuration
package.yml
name: my-package
modulename: my_module
version: 0.1.0
license: MIT
description: My first every package built with Shut
author: Me <me@example.org>
requirements:
- python ^3.5
- requests ^2.22.0
entrypoints:
console_scripts:
- mycli = my_module.__main__:mycli
Todo
- Bump version based on changelog
- Package data / data files
- Conda recipe generator
- Automatic check for license headers in files / automatically insert license headers
- Dev-install packages from mono repositories
Copyright © 2020, Niklas Rosenstein
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
shut-0.5.0.tar.gz
(53.1 kB
view details)
Built Distribution
shut-0.5.0-py3-none-any.whl
(169.4 kB
view details)
File details
Details for the file shut-0.5.0.tar.gz
.
File metadata
- Download URL: shut-0.5.0.tar.gz
- Upload date:
- Size: 53.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ddd79d9b5729cc23310b98857c80ceb390de1c539248c3d87145e979ef1d8bc |
|
MD5 | 751938a1145a740ef50fe1516797f9e7 |
|
BLAKE2b-256 | 8427f8c45d14bb68ca2e5212ee6b3dc1a559689c98e6217100bb55cd3c61a5dc |
File details
Details for the file shut-0.5.0-py3-none-any.whl
.
File metadata
- Download URL: shut-0.5.0-py3-none-any.whl
- Upload date:
- Size: 169.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e2357305168733ca5d4386abf1a6fee8bf2e57101b177ae25b164140b4ca5cd |
|
MD5 | 8b226371d52033dd3f39c29ad815a168 |
|
BLAKE2b-256 | 6ba9605a4f63b84d9c08cbd59b44a7d3b4930692ee519628ca593926ff7b823d |