Skip to main content

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

  • Package data / data files
  • Conda recipe generator
  • Automatic check for license headers in files / automatically insert license headers

Copyright © 2020, Niklas Rosenstein

Project details


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.6.0.tar.gz (56.9 kB view details)

Uploaded Source

Built Distribution

shut-0.6.0-py3-none-any.whl (128.5 kB view details)

Uploaded Python 3

File details

Details for the file shut-0.6.0.tar.gz.

File metadata

  • Download URL: shut-0.6.0.tar.gz
  • Upload date:
  • Size: 56.9 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.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.7

File hashes

Hashes for shut-0.6.0.tar.gz
Algorithm Hash digest
SHA256 b3057578b05552faac3f2035a0301b06bebae97533ead47f8cc12e30048bd0dd
MD5 87b0e137212059b06cbb597d4ff263da
BLAKE2b-256 4dceea03e3943300dc1d42b214ee77127df701a783212bdd96732e3ae987a1c2

See more details on using hashes here.

File details

Details for the file shut-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: shut-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 128.5 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.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.7

File hashes

Hashes for shut-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b289ce0c04494003bb53f12fb0bc4664700f097a5c3121870e369b326742b68
MD5 096fde0541e0a2cf4bb34e62656c98eb
BLAKE2b-256 d877e4c976f070b1a53781772b9df7bbf47b5729d00ce69190dc860bc7d70e7b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page