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

Uploaded Source

Built Distribution

shut-0.10.0-py3-none-any.whl (197.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shut-0.10.0.tar.gz
  • Upload date:
  • Size: 60.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.3

File hashes

Hashes for shut-0.10.0.tar.gz
Algorithm Hash digest
SHA256 47aa3dcce083b9b66ea8ac11587f5804d1855ee8aca33500500c45bf51149485
MD5 893f9b9318c65607d99ff96e32d262bf
BLAKE2b-256 b658e8e625d737c029e68d3299e5f31dbf6f6b5013f6585af8459fa8bce25c42

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shut-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 197.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.3

File hashes

Hashes for shut-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 00b0fdd5e87083fa953bb6f094d823db047c21b7bb6ec463ccc02e8ff6accdc1
MD5 e53c4461dcc5b8717272e6d68cd84ddc
BLAKE2b-256 5086e54b2f4844a124cabe676ea2cfeadc4ee4fd8bb952144ca5a3a3724ad66a

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