Skip to main content

Generate shell completions and man page.

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 a python package is building.

Usage

Add this package to your build requires:

[build-system]
requires = [ "setuptools >= 45", "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 build/resources:

$ tree build/resources
 build/resources
├──  demo-0.0.1-py3-none-any.whl  # wheel file
├──  demo-0.0.1.tar.gz  # source distribution file
├──  demo.1.gz  # man page
├──  demo.1.md  # markdown converted from the man page for document
└──  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.1.tar.gz (31.1 kB view details)

Uploaded Source

Built Distribution

setuptools_generate-0.0.1-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for setuptools-generate-0.0.1.tar.gz
Algorithm Hash digest
SHA256 6c952ced6897adea2311e1db7ce4aaea3c5dd4e78604286fd1a3fc3fb73c3158
MD5 fb5182c8bbfdf225d03b83ab234845f7
BLAKE2b-256 2f49e7ada61abb60fb6c75e74e629b61af80a15b9bcc02b43a3c64fc52bd6cc8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for setuptools_generate-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c1095f91c01cec78a2b87d7a0b588ef5b531c8f2fb5456e5d2718f0db05b1465
MD5 3b4c21753207bc96027bf4828bc19c14
BLAKE2b-256 18ac19e156910100f592b5c20fdfc6109d666040b1d717fb11998979504f6d9e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page