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 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  # 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.5.tar.gz (35.1 kB view details)

Uploaded Source

Built Distribution

setuptools_generate-0.0.5-py3-none-any.whl (21.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: setuptools-generate-0.0.5.tar.gz
  • Upload date:
  • Size: 35.1 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.5.tar.gz
Algorithm Hash digest
SHA256 aeb778bee03bbff65aedd5868d3ccba92809da1d39aa345858f023dacf730e1e
MD5 468e1ab9adb9e75108c35ba8c7c02e3f
BLAKE2b-256 8f308b65f5d4cfa44c803e9d51cef3def087941f90676df24920e7db26ade11b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for setuptools_generate-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 906ddc6707af96e81c3f80d311de32c3809a2fee7b7f0930df26d2a5c04b2994
MD5 fa9ceec5a896abf32a8faeaa254ba99e
BLAKE2b-256 179f757f2c3f07e74bbb5e158a7df3ba8cfec090242d5a9723ec37d395d4cdcc

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