Skip to main content

Generate shell completions and man page when building a python package.

Project description

setuptools-generate

pre-commit.ci status github/workflow codecov readthedocs

github/downloads github/downloads/latest github/issues github/issues-closed github/issues-pr github/issues-pr-closed github/discussions github/milestones github/forks github/stars github/watchers github/contributors github/commit-activity github/last-commit github/release-date

github/license github/languages github/languages/top github/directory-file-count github/code-size github/repo-size github/v

pypi/status pypi/v pypi/downloads pypi/format pypi/implementation pypi/pyversions

Generate shell completions and man page when building a python package.

Usage

Add this package to your build requires:

[build-system]
requires = [ "setuptools-generate",]
build-backend = "setuptools.build_meta"

[project]
name = "demo"
version = "0.0.1"

[project.scripts]
demo = "demo:main"

Build your package:

python -m build

See your sdist:

$ tree sdist
 sdist
├──  _demo  # zsh completion script
├──  demo  # bash completion script
├──  demo-0.0.1-py3-none-any.whl  # wheel file
├──  demo-0.0.1.tar.gz  # source distribution file
├──  demo.1  # man page
└──  demo.fish  # fish completion script

You got them.

Example projects:

See document to know more.

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

setuptools-generate-0.0.6.tar.gz (35.2 kB view details)

Uploaded Source

Built Distribution

setuptools_generate-0.0.6-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

Details for the file setuptools-generate-0.0.6.tar.gz.

File metadata

  • Download URL: setuptools-generate-0.0.6.tar.gz
  • Upload date:
  • Size: 35.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for setuptools-generate-0.0.6.tar.gz
Algorithm Hash digest
SHA256 6e23241d9ecfdfddf9e50a495f3092b60be3ca6f4a5e116c8c3e7f2b646ba725
MD5 96928aff3fc29838326cd74c0d866563
BLAKE2b-256 83f219e81145066e3c4e4b5ecd45210cbb8402ad6ac8f1a89b5056fa5520fca3

See more details on using hashes here.

File details

Details for the file setuptools_generate-0.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for setuptools_generate-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 82d0426ab65c32a6ac822c016b30ef4d9a8aa9aa23df306842a3d84ab12d6cc0
MD5 7d61fa749285c7f60bc8d7fe65c296e2
BLAKE2b-256 f06036f1f52314819aac209d0d629f71ff09718331b2832386c84ec575f7f343

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