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

Uploaded Source

Built Distribution

shut-0.9.0-py3-none-any.whl (131.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shut-0.9.0.tar.gz
  • Upload date:
  • Size: 62.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

File hashes

Hashes for shut-0.9.0.tar.gz
Algorithm Hash digest
SHA256 002015ce7ef01379c5cae53e8c98972721951c9e21942c24f723e248624d58b0
MD5 eb6657eae76bc881d37aff35c9be229d
BLAKE2b-256 7ab50a64844f88130ddbb2b060ed3aa6911c5f9b5299b512033bdd68c42a79ee

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shut-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 131.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

File hashes

Hashes for shut-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d3635d2cd2a9ccae82451ff3ff6dc59c374ba863eaa130d167a31b7600074514
MD5 535a6aad0b1d03ad101bb3b4890aa490
BLAKE2b-256 01e0633b7848ebea732d2fdb14030f0bb1404d1a1c03ec6dbb87d10361eb98d1

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