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

Uploaded Source

Built Distribution

setuptools_generate-0.0.3-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: setuptools-generate-0.0.3.tar.gz
  • Upload date:
  • Size: 33.9 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.3.tar.gz
Algorithm Hash digest
SHA256 e7c29d7508cbb2bf39fd95125d81d1f7065ac597becfec4372b2f15a4cd33d32
MD5 d1fc64f1ab36510f176c61ebe40516fe
BLAKE2b-256 cb715e279e65b913a62ad0682bfd920eaaab889f28f5d55b3e916583860f7ba2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for setuptools_generate-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e5e4af07ce568d19b95beb7fda75f85a3f20dd6b01d49343e769206551bd692d
MD5 82cdd0de0d72dc9cc38250a1661340a7
BLAKE2b-256 f9932a508f982741d84b439d70334a6fd70d85f1f0b343ce2893bc82fd46fa4a

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