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

Uploaded Source

Built Distribution

shut-0.7.0-py3-none-any.whl (129.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shut-0.7.0.tar.gz
  • Upload date:
  • Size: 57.7 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.7.0.tar.gz
Algorithm Hash digest
SHA256 2a724751de121cc14a5d05e86a11beb3204a684b02d4de99130fa229783cca9a
MD5 747a88dddc5a82cf827cbcc171cc57ca
BLAKE2b-256 e00d7b2f1936bcb0be9702f819853343d220ee8f446d1f1ba7ba2f6a77ad5aa2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shut-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 129.7 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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6ffbd690ae16f0fca2c3bc9e154a0f489a3f72ea0702691927c86b884cca9040
MD5 cfedb2fc0c17fa07017dc77566fe4d7e
BLAKE2b-256 071f762af797bf5db8bfbaef850d0017e5563dddc3723290f7b393839f258a1f

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