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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: setuptools-generate-0.0.2.tar.gz
  • Upload date:
  • Size: 31.5 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.2.tar.gz
Algorithm Hash digest
SHA256 b321ce712d07194f9c1dcd5ed3bbb63d692d130db377cc4ce994d3037c0a35d3
MD5 449e897ac7562c15885a7520826e9264
BLAKE2b-256 bd0cb02e7d47f7d9823645a5df4c6a460844c1638aa76fa89ed80430502d3ef9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for setuptools_generate-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6832823d0e3a67f78dde8c65ebe9f8f794c1b1b6fd77b26709887a5e5e981c37
MD5 005c745b19cfc97eaef9bc0e435d5ef8
BLAKE2b-256 3aecd4b480e6991a827470eace13ac6689f85a8b7dab9c5da75e9478880f026f

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