zen-cli 0.1.1__tar.gz

zen_cli-0.1.1/.gitignore

@@ -0,0 +1,12 @@
+.venv/
+dist/
+build/
+*.egg-info/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+__pycache__/
+*.py[cod]
+.pypirc
+.coverage
+htmlcov/

zen_cli-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 zen-cli authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

zen_cli-0.1.1/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.5
+Name: zen-cli
+Version: 0.1.1
+Summary: A small command-line toolkit.
+Project-URL: Homepage, https://pypi.org/project/zen-cli/
+Author: zen-cli authors
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: <3.13,>=3.12
+Requires-Dist: click>=8.1
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: release
+Requires-Dist: build; extra == 'release'
+Requires-Dist: twine; extra == 'release'
+Description-Content-Type: text/markdown
+
+# zen-cli
+
+Python 3.12 command-line skeleton. All local workflow goes through `dev.py`.
+
+## Develop
+
+You need Python 3.12. On Windows, if `python` is another version, use `py -3.12`:
+
+```text
+py -3.12 dev.py init
+zen --help
+```
+
+`init` creates `.venv`, runs `pip install -U -e ".[dev]"`, and installs git hooks.
+
+| Command | What it does |
+|---|---|
+| `python dev.py init` | Create the env and editable-install the CLI |
+| `python dev.py lint` | Ruff fix/format and mypy |
+| `python dev.py test` | unittest |
+| `python dev.py bump [--part patch\|minor\|major]` | Change `version` in `pyproject.toml` |
+| `python dev.py publish` | Build and upload to PyPI |
+| `python dev.py release [--part patch]` | lint, test, bump, then publish |
+| `python dev.py clean [--venv]` | Remove artifacts; `--venv` also deletes `.venv` |
+
+Publish needs a PyPI API token in `TWINE_PASSWORD` (optional `TWINE_USERNAME=__token__`) or `~/.pypirc`. Do not commit credentials. PyPI rejects uploading the same version twice.
+
+## Jenkins
+
+The `Jenkinsfile` only calls `dev.py`. Default runs `init`, `lint`, and `test`. Set `PUBLISH=true` to run `release`. Store the PyPI token as a Jenkins secret text credential named `pypi-api-token`.
+
+## Install a published build
+
+```text
+pip install zen-cli
+pipx install zen-cli
+```

zen_cli-0.1.1/README.md

@@ -0,0 +1,37 @@
+# zen-cli
+
+Python 3.12 command-line skeleton. All local workflow goes through `dev.py`.
+
+## Develop
+
+You need Python 3.12. On Windows, if `python` is another version, use `py -3.12`:
+
+```text
+py -3.12 dev.py init
+zen --help
+```
+
+`init` creates `.venv`, runs `pip install -U -e ".[dev]"`, and installs git hooks.
+
+| Command | What it does |
+|---|---|
+| `python dev.py init` | Create the env and editable-install the CLI |
+| `python dev.py lint` | Ruff fix/format and mypy |
+| `python dev.py test` | unittest |
+| `python dev.py bump [--part patch\|minor\|major]` | Change `version` in `pyproject.toml` |
+| `python dev.py publish` | Build and upload to PyPI |
+| `python dev.py release [--part patch]` | lint, test, bump, then publish |
+| `python dev.py clean [--venv]` | Remove artifacts; `--venv` also deletes `.venv` |
+
+Publish needs a PyPI API token in `TWINE_PASSWORD` (optional `TWINE_USERNAME=__token__`) or `~/.pypirc`. Do not commit credentials. PyPI rejects uploading the same version twice.
+
+## Jenkins
+
+The `Jenkinsfile` only calls `dev.py`. Default runs `init`, `lint`, and `test`. Set `PUBLISH=true` to run `release`. Store the PyPI token as a Jenkins secret text credential named `pypi-api-token`.
+
+## Install a published build
+
+```text
+pip install zen-cli
+pipx install zen-cli
+```

zen_cli-0.1.1/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["hatchling>=1.26"]
+build-backend = "hatchling.build"
+
+[project]
+name = "zen-cli"
+version = "0.1.1"
+description = "A small command-line toolkit."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.12,<3.13"
+authors = [{ name = "zen-cli authors" }]
+dependencies = ["click>=8.1"]
+
+[project.optional-dependencies]
+dev = ["build", "pre-commit", "ruff", "mypy"]
+release = ["build", "twine"]
+
+[project.scripts]
+zen = "zen_cli.cli:cli"
+
+[project.urls]
+Homepage = "https://pypi.org/project/zen-cli/"
+
+[tool.hatch.build.targets.sdist]
+include = ["src/zen_cli", "tests", "README.md", "LICENSE"]
+
+[tool.ruff]
+target-version = "py312"
+line-length = 88
+src = ["src"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM", "RUF"]
+
+[tool.mypy]
+python_version = "3.12"
+strict = true
+files = ["src"]

zen_cli-0.1.1/src/zen_cli/__init__.py

@@ -0,0 +1 @@
+"""zen-cli package."""

zen_cli-0.1.1/src/zen_cli/__main__.py

@@ -0,0 +1,4 @@
+from zen_cli.cli import cli
+
+if __name__ == "__main__":
+    cli()

zen_cli-0.1.1/src/zen_cli/cli.py

@@ -0,0 +1,12 @@
+import click
+
+from zen_cli.commands.hello import hello
+
+
+@click.group(name="zen")
+@click.version_option(package_name="zen-cli", prog_name="zen")
+def cli() -> None:
+    """zen command-line interface."""
+
+
+cli.add_command(hello)

zen_cli-0.1.1/src/zen_cli/commands/__init__.py

@@ -0,0 +1 @@
+"""Click subcommands."""

zen_cli-0.1.1/src/zen_cli/commands/hello.py

@@ -0,0 +1,7 @@
+import click
+
+
+@click.command()
+def hello() -> None:
+    """Print a short greeting."""
+    click.echo("Hello from zen.")

zen_cli-0.1.1/tests/test_cli.py

@@ -0,0 +1,24 @@
+import unittest
+from importlib.metadata import version
+
+from click.testing import CliRunner
+
+from zen_cli.cli import cli
+
+
+class TestCli(unittest.TestCase):
+    def test_help(self) -> None:
+        result = CliRunner().invoke(cli, ["--help"])
+        self.assertEqual(result.exit_code, 0)
+        self.assertIn("Usage:", result.output)
+
+    def test_version(self) -> None:
+        result = CliRunner().invoke(cli, ["--version"])
+        self.assertEqual(result.exit_code, 0)
+        self.assertIn("zen, version", result.output)
+        self.assertIn(version("zen-cli"), result.output)
+
+    def test_hello(self) -> None:
+        result = CliRunner().invoke(cli, ["hello"])
+        self.assertEqual(result.exit_code, 0)
+        self.assertIn("Hello from zen.", result.output)