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

  • 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


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

Uploaded Source

Built Distribution

shut-0.4.0-py3-none-any.whl (159.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shut-0.4.0.tar.gz
  • Upload date:
  • Size: 48.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/49.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.3

File hashes

Hashes for shut-0.4.0.tar.gz
Algorithm Hash digest
SHA256 30ef3a742da6c96a4d251a402f943fb2e2f644ca3633848f4178951691671ff8
MD5 0d1863cece228f64dd5678aad4f0b44a
BLAKE2b-256 23d6de161ad9cdcb85fef8027608a8dd15f111f4d720294b71937d976446c966

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shut-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 159.1 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/49.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.3

File hashes

Hashes for shut-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6f15c95f9dbc848f9d980e737f14ab74fe874180274830d72b12041382600ee8
MD5 89ab6545414a1a3b37f6e5fa811970c8
BLAKE2b-256 75c6bb57422e246c93440a380dc42475a1de9faeb29ea460e695177c8c24d359

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