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

Uploaded Source

Built Distribution

shut-0.7.3-py3-none-any.whl (130.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shut-0.7.3.tar.gz
  • Upload date:
  • Size: 61.0 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.8.5

File hashes

Hashes for shut-0.7.3.tar.gz
Algorithm Hash digest
SHA256 54eb52b739e0c9a0fdca9308569e9a2e8328f53e678a32e1550220b41c36498d
MD5 0c87395ae6cb9752f5b6b4fd624f53f6
BLAKE2b-256 f49a33ad68ab03ef4d0bb2ada14f4dc730773f44b44e1ee12a0c7f37f0d6ea1a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shut-0.7.3-py3-none-any.whl
  • Upload date:
  • Size: 130.0 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.8.5

File hashes

Hashes for shut-0.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bee5eca216b6c5bed0b3d4242db912301353a4406c3f860749ba43d8c30c7481
MD5 40bd57870d1415316c71ec285bc66e51
BLAKE2b-256 bc70c512fe5e76190ceafcf1a27c967606df95aecce292a7a7f27e36306ed382

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