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 >= 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.4.tar.gz (32.9 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: setuptools-generate-0.0.4.tar.gz
  • Upload date:
  • Size: 32.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.4.tar.gz
Algorithm Hash digest
SHA256 c5556c1cdd1c97ac11fc2cfa9f1f023dcc812c065dc8cec0b66cedeec32a9902
MD5 c1c75676f3242f3df82b81b99508e31d
BLAKE2b-256 08e88fca607792d39f867acfa202f3e632ccb08e77c29f1253257e30e233c536

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for setuptools_generate-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 bde11758f332e8a62080f0acacf54121b6fde48928e5a656535484a9a2198690
MD5 09b5fb728bbf75d4b448260707e2cc44
BLAKE2b-256 bef7f561eab06a7718017043264beb2c6c2af17774f48888525990fbcbbe267b

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