| Name | setuptools-generate JSON |
| Version |
0.0.6
JSON |
| download |
| home_page | |
| Summary | Generate shell completions and man page when building a python package. |
| upload_time | 2023-04-05 23:00:07 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | GPL v3 |
| keywords |
shell completion
man
build
setuptools
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# setuptools-generate
[](https://results.pre-commit.ci/latest/github/Freed-Wu/setuptools-generate/main)
[](https://github.com/Freed-Wu/setuptools-generate/actions)
[](https://codecov.io/gh/Freed-Wu/setuptools-generate)
[](https://setuptools-generate.readthedocs.io)
[](https://github.com/Freed-Wu/setuptools-generate/releases)
[](https://github.com/Freed-Wu/setuptools-generate/releases/latest)
[](https://github.com/Freed-Wu/setuptools-generate/issues)
[](https://github.com/Freed-Wu/setuptools-generate/issues?q=is%3Aissue+is%3Aclosed)
[](https://github.com/Freed-Wu/setuptools-generate/pulls)
[](https://github.com/Freed-Wu/setuptools-generate/pulls?q=is%3Apr+is%3Aclosed)
[](https://github.com/Freed-Wu/setuptools-generate/discussions)
[](https://github.com/Freed-Wu/setuptools-generate/milestones)
[](https://github.com/Freed-Wu/setuptools-generate/network/members)
[](https://github.com/Freed-Wu/setuptools-generate/stargazers)
[](https://github.com/Freed-Wu/setuptools-generate/watchers)
[](https://github.com/Freed-Wu/setuptools-generate/graphs/contributors)
[](https://github.com/Freed-Wu/setuptools-generate/graphs/commit-activity)
[](https://github.com/Freed-Wu/setuptools-generate/commits)
[](https://github.com/Freed-Wu/setuptools-generate/releases/latest)
[](https://github.com/Freed-Wu/setuptools-generate/blob/main/LICENSE)
[](https://github.com/Freed-Wu/setuptools-generate)
[](https://github.com/Freed-Wu/setuptools-generate)
[](https://github.com/Freed-Wu/setuptools-generate)
[](https://github.com/Freed-Wu/setuptools-generate)
[](https://github.com/Freed-Wu/setuptools-generate)
[](https://github.com/Freed-Wu/setuptools-generate)
[](https://pypi.org/project/setuptools-generate/#description)
[](https://pypi.org/project/setuptools-generate/#history)
[](https://pypi.org/project/setuptools-generate/#files)
[](https://pypi.org/project/setuptools-generate/#files)
[](https://pypi.org/project/setuptools-generate/#files)
[](https://pypi.org/project/setuptools-generate/#files)
Generate shell completions and man page when building a python package.
## Usage
Add this package to your build requires:
```toml
[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:
```sh
python -m build
```
See your `sdist`:
```console
$ tree sdist
sdist
├── _demo # zsh completion script
├── demo # bash completion script
├── demo-0.0.1-py3-none-any.whl # wheel file
├── demo-0.0.1.tar.gz # source distribution file
├── demo.1 # man page
└── demo.fish # fish completion script
```
You got them.
Example projects:
- [demo for click](https://github.com/Freed-Wu/setuptools-generate/tree/main/tests/click/src)
- [demo for shtab](https://github.com/Freed-Wu/setuptools-generate/tree/main/tests/shtab/src)
- [translate-shell](https://github.com/Freed-Wu/translate-shell)
See [document](https://setuptools-generate.readthedocs.io) to know more.
Raw data
{
"_id": null,
"home_page": "",
"name": "setuptools-generate",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "shell completion,man,build,setuptools",
"author": "",
"author_email": "Wu Zhenyu <wuzhenyu@ustc.edu>",
"download_url": "https://files.pythonhosted.org/packages/83/f2/19e81145066e3c4e4b5ecd45210cbb8402ad6ac8f1a89b5056fa5520fca3/setuptools-generate-0.0.6.tar.gz",
"platform": null,
"description": "# setuptools-generate\n\n[](https://results.pre-commit.ci/latest/github/Freed-Wu/setuptools-generate/main)\n[](https://github.com/Freed-Wu/setuptools-generate/actions)\n[](https://codecov.io/gh/Freed-Wu/setuptools-generate)\n[](https://setuptools-generate.readthedocs.io)\n\n[](https://github.com/Freed-Wu/setuptools-generate/releases)\n[](https://github.com/Freed-Wu/setuptools-generate/releases/latest)\n[](https://github.com/Freed-Wu/setuptools-generate/issues)\n[](https://github.com/Freed-Wu/setuptools-generate/issues?q=is%3Aissue+is%3Aclosed)\n[](https://github.com/Freed-Wu/setuptools-generate/pulls)\n[](https://github.com/Freed-Wu/setuptools-generate/pulls?q=is%3Apr+is%3Aclosed)\n[](https://github.com/Freed-Wu/setuptools-generate/discussions)\n[](https://github.com/Freed-Wu/setuptools-generate/milestones)\n[](https://github.com/Freed-Wu/setuptools-generate/network/members)\n[](https://github.com/Freed-Wu/setuptools-generate/stargazers)\n[](https://github.com/Freed-Wu/setuptools-generate/watchers)\n[](https://github.com/Freed-Wu/setuptools-generate/graphs/contributors)\n[](https://github.com/Freed-Wu/setuptools-generate/graphs/commit-activity)\n[](https://github.com/Freed-Wu/setuptools-generate/commits)\n[](https://github.com/Freed-Wu/setuptools-generate/releases/latest)\n\n[](https://github.com/Freed-Wu/setuptools-generate/blob/main/LICENSE)\n[](https://github.com/Freed-Wu/setuptools-generate)\n[](https://github.com/Freed-Wu/setuptools-generate)\n[](https://github.com/Freed-Wu/setuptools-generate)\n[](https://github.com/Freed-Wu/setuptools-generate)\n[](https://github.com/Freed-Wu/setuptools-generate)\n[](https://github.com/Freed-Wu/setuptools-generate)\n\n[](https://pypi.org/project/setuptools-generate/#description)\n[](https://pypi.org/project/setuptools-generate/#history)\n[](https://pypi.org/project/setuptools-generate/#files)\n[](https://pypi.org/project/setuptools-generate/#files)\n[](https://pypi.org/project/setuptools-generate/#files)\n[](https://pypi.org/project/setuptools-generate/#files)\n\nGenerate shell completions and man page when building a python package.\n\n## Usage\n\nAdd this package to your build requires:\n\n```toml\n[build-system]\nrequires = [ \"setuptools-generate\",]\nbuild-backend = \"setuptools.build_meta\"\n\n[project]\nname = \"demo\"\nversion = \"0.0.1\"\n\n[project.scripts]\ndemo = \"demo:main\"\n```\n\nBuild your package:\n\n```sh\npython -m build\n```\n\nSee your `sdist`:\n\n```console\n$ tree sdist\n\uf115 sdist\n\u251c\u2500\u2500 \uf15b _demo # zsh completion script\n\u251c\u2500\u2500 \uf15b demo # bash completion script\n\u251c\u2500\u2500 \uf15b demo-0.0.1-py3-none-any.whl # wheel file\n\u251c\u2500\u2500 \uf410 demo-0.0.1.tar.gz # source distribution file\n\u251c\u2500\u2500 \uf15b demo.1 # man page\n\u2514\u2500\u2500 \uf489 demo.fish # fish completion script\n```\n\nYou got them.\n\nExample projects:\n\n- [demo for click](https://github.com/Freed-Wu/setuptools-generate/tree/main/tests/click/src)\n- [demo for shtab](https://github.com/Freed-Wu/setuptools-generate/tree/main/tests/shtab/src)\n- [translate-shell](https://github.com/Freed-Wu/translate-shell)\n\nSee [document](https://setuptools-generate.readthedocs.io) to know more.\n",
"bugtrack_url": null,
"license": "GPL v3",
"summary": "Generate shell completions and man page when building a python package.",
"version": "0.0.6",
"split_keywords": [
"shell completion",
"man",
"build",
"setuptools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f06036f1f52314819aac209d0d629f71ff09718331b2832386c84ec575f7f343",
"md5": "7d61fa749285c7f60bc8d7fe65c296e2",
"sha256": "82d0426ab65c32a6ac822c016b30ef4d9a8aa9aa23df306842a3d84ab12d6cc0"
},
"downloads": -1,
"filename": "setuptools_generate-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7d61fa749285c7f60bc8d7fe65c296e2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 20941,
"upload_time": "2023-04-05T23:00:06",
"upload_time_iso_8601": "2023-04-05T23:00:06.110841Z",
"url": "https://files.pythonhosted.org/packages/f0/60/36f1f52314819aac209d0d629f71ff09718331b2832386c84ec575f7f343/setuptools_generate-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "83f219e81145066e3c4e4b5ecd45210cbb8402ad6ac8f1a89b5056fa5520fca3",
"md5": "96928aff3fc29838326cd74c0d866563",
"sha256": "6e23241d9ecfdfddf9e50a495f3092b60be3ca6f4a5e116c8c3e7f2b646ba725"
},
"downloads": -1,
"filename": "setuptools-generate-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "96928aff3fc29838326cd74c0d866563",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 35156,
"upload_time": "2023-04-05T23:00:07",
"upload_time_iso_8601": "2023-04-05T23:00:07.257836Z",
"url": "https://files.pythonhosted.org/packages/83/f2/19e81145066e3c4e4b5ecd45210cbb8402ad6ac8f1a89b5056fa5520fca3/setuptools-generate-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-05 23:00:07",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "setuptools-generate"
}
