huly-cli 0.1.0__tar.gz

huly_cli-0.1.0/.env.example

@@ -0,0 +1,8 @@
+# Minimal required config
+HULY_URL=https://huly.ingenuity.ph
+HULY_WORKSPACE=efs
+
+# Optional for interactive local use.
+# Recommended for non-interactive runs or automatic re-auth when the cached token expires.
+HULY_EMAIL=you@example.com
+HULY_PASSWORD=your-password

huly_cli-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: huly-cli CI
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Lint (ruff check)
+        run: uv run ruff check .
+
+      - name: Format check (ruff format)
+        run: uv run ruff format --check .
+
+      - name: Run tests
+        run: uv run pytest tests/ -v
+
+      - name: Build distributions
+        run: uv run python -m build
+
+      - name: Validate distribution metadata
+        run: uv run twine check dist/*

huly_cli-0.1.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,61 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Build distributions
+        run: uv run python -m build
+
+      - name: Validate distribution metadata
+        run: uv run twine check dist/*
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    environment:
+      name: pypi
+      url: https://pypi.org/p/huly-cli
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

huly_cli-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+node_modules/
+dist/
+build/
+.env
+.pypirc
+*.log
+.DS_Store
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+.venv/
+*.egg-info/
+.specstory/
+.vscode/

huly_cli-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

huly_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+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.

huly_cli-0.1.0/PKG-INFO

@@ -0,0 +1,345 @@
+Metadata-Version: 2.4
+Name: huly-cli
+Version: 0.1.0
+Summary: CLI for Huly project management
+Project-URL: Homepage, https://github.com/teslakoile/huly-cli
+Project-URL: Repository, https://github.com/teslakoile/huly-cli
+Project-URL: Issues, https://github.com/teslakoile/huly-cli/issues
+License: MIT License
+        
+        Copyright (c) 2026
+        
+        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.
+License-File: LICENSE
+Keywords: cli,huly,project-management
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: httpx<1.0,>=0.28.0
+Requires-Dist: pydantic<3.0,>=2.10.0
+Requires-Dist: python-dotenv<2.0,>=1.0.0
+Requires-Dist: rich<14.0,>=13.9.0
+Requires-Dist: tomli-w<2.0,>=1.1.0
+Requires-Dist: typer<1.0,>=0.15.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2.2; extra == 'dev'
+Requires-Dist: pre-commit>=3.5.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.22.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Requires-Dist: twine>=6.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# huly-cli
+
+Python CLI for interacting with a Huly workspace from the terminal.
+
+## Status
+
+This repo is currently a Python `typer` CLI, not a Node or `pnpm` project.
+
+It has been checked against `hcengineering/platform@v0.6.504` and smoke-tested against
+`https://huly.ingenuity.ph` workspace `efs`.
+
+What is verified today:
+
+- Authentication flow via `/_accounts`
+- Read access for projects, issues, components, documents, templates, members, labels, and issue descriptions
+- Live CRUD for issues, documents, components, and milestones on `https://huly.ingenuity.ph` workspace `efs`
+- Live template description update and restore flow
+- Workspace-specific issue status display and status filtering
+- Local unit/CLI test suite
+- CI-equivalent local checks:
+  `uv sync --extra dev`, `uv run ruff check .`, `uv run ruff format --check .`,
+  `uv run pytest tests/ -v`, `uv run python -m build`, and `uv run twine check dist/*`
+
+What is not fully verified yet:
+
+- Automated live-workspace CI has not been added
+- You should still prefer a disposable project or disposable teamspace for release-time live smoke tests
+
+Known live compatibility gaps at the time of writing:
+
+- No known read-path breakage remains from the `v0.6.504` comparison and smoke tests
+- No known CLI CRUD gap remains on the currently implemented issue, document, component, and milestone surfaces
+- The test suite now patches auth correctly; it no longer depends on a developer's local cached login state
+
+## Compatibility Target
+
+- Huly platform tag: `v0.6.504`
+- Example workspace URL used during verification:
+  `https://huly.ingenuity.ph/workbench/efs/tracker/69cb986a2df46a01935af670/issues`
+
+Important distinction:
+
+- `efs` is the workspace slug
+- `ROA` is the project identifier in that workspace
+
+If you run `huly issues list --project EFS`, it will fail because `EFS` is not a project ID.
+
+## Prerequisites
+
+- Python `3.11+`
+- [`uv`](https://docs.astral.sh/uv/)
+- A Huly account with access to the target workspace
+
+## Setup
+
+1. Install dependencies, including dev tools:
+
+```bash
+uv sync --extra dev
+```
+
+2. Copy the example environment file:
+
+```bash
+cp .env.example .env
+```
+
+3. Edit `.env` with at least:
+
+- `HULY_URL`
+- `HULY_WORKSPACE`
+
+4. Choose one auth approach:
+
+- Interactive login: preferred for local use
+- Environment-based login: useful for non-interactive runs and token refresh
+
+## Environment Variables
+
+The CLI loads config in this order:
+
+1. CLI flags
+2. Environment variables
+3. `.env` in the current directory
+4. `~/.config/huly/config.toml`
+
+Supported variables:
+
+- `HULY_URL`
+- `HULY_WORKSPACE`
+- `HULY_EMAIL`
+- `HULY_PASSWORD`
+
+Auth cache location:
+
+- Config: `~/.config/huly/config.toml`
+- Tokens: `~/.config/huly/auth.json`
+
+The token cache is reused automatically. If the cached token expires, the CLI needs
+`HULY_EMAIL` and `HULY_PASSWORD` available in order to re-authenticate automatically.
+
+## Login Walkthrough
+
+### Option 1: Interactive login
+
+This is the simplest flow if you are testing locally and do not want to keep your password
+in `.env`.
+
+```bash
+uv run huly --url https://huly.ingenuity.ph --workspace efs auth login
+```
+
+You will be prompted for:
+
+- Email
+- Password
+- Workspace slug, if it was not passed on the command line or set in `.env`
+
+Then confirm auth is valid:
+
+```bash
+uv run huly auth status
+```
+
+### Option 2: Login using `.env`
+
+Put all four values in `.env`:
+
+```bash
+HULY_URL=https://huly.ingenuity.ph
+HULY_WORKSPACE=efs
+HULY_EMAIL=you@example.com
+HULY_PASSWORD=your-password
+```
+
+Then run:
+
+```bash
+uv run huly auth login
+uv run huly auth status
+```
+
+## Hands-On Smoke Test
+
+These commands are the safest live checks to run today.
+
+If you want the repo to drive the same smoke pass for you:
+
+```bash
+uv run python scripts/live_smoke.py
+```
+
+To include live CRUD checks with automatic cleanup:
+
+```bash
+uv run python scripts/live_smoke.py --allow-writes
+```
+
+1. Confirm auth:
+
+```bash
+uv run huly auth status
+```
+
+2. List projects:
+
+```bash
+uv run huly projects list
+```
+
+3. Inspect the verified sample project:
+
+```bash
+uv run huly projects get ROA
+```
+
+4. List a few issues from that project:
+
+```bash
+uv run huly issues list --project ROA --limit 5
+```
+
+5. Inspect one issue:
+
+```bash
+uv run huly issues get ROA-1
+```
+
+6. Read the issue description:
+
+```bash
+uv run huly issues describe ROA-1
+```
+
+7. List project components:
+
+```bash
+uv run huly components list --project ROA --limit 5
+```
+
+8. Inspect a component by internal ID:
+
+```bash
+uv run huly components get 16e202fa79377835295c79eb
+```
+
+9. List a few documents:
+
+```bash
+uv run huly documents list --limit 5
+```
+
+10. List issue templates:
+
+```bash
+uv run huly templates list --limit 5
+```
+
+11. Verify status filtering:
+
+```bash
+uv run huly issues list --status backlog --limit 5
+```
+
+12. List workspace members:
+
+```bash
+uv run huly members list
+```
+
+13. List labels:
+
+```bash
+uv run huly labels list
+```
+
+### JSON mode
+
+If you want machine-readable output for quick inspection:
+
+```bash
+uv run huly --json projects list
+uv run huly --json issues list --project ROA --limit 5
+uv run huly --json auth status
+```
+
+## Commands That Currently Need Caution
+
+The CLI write paths were exercised live during verification, but you should still
+prefer a disposable project or disposable teamspace when doing release-time smoke
+tests against a real workspace.
+
+## Local Test Suite
+
+Run the unit and CLI regression tests with:
+
+```bash
+uv run --extra dev pytest -q
+```
+
+Expected result at the time of verification:
+
+- `155 passed`
+
+## Packaging And PyPI
+
+The repo now builds a wheel and sdist cleanly and CI validates the distribution
+metadata.
+
+For the full release checklist, including the manual PyPI setup you still need
+to do, see [RELEASE.md](RELEASE.md).
+
+## CLI Help
+
+Top-level help:
+
+```bash
+uv run huly --help
+```
+
+Auth help:
+
+```bash
+uv run huly auth login --help
+```
+
+## License
+
+MIT