youtrack-cli 0.2.1__tar.gz → 0.3.0__tar.gz

{youtrack_cli-0.2.1 → youtrack_cli-0.3.0}/.claude/settings.local.json

@@ -36,7 +36,11 @@
       "Bash(yt:*)",
       "Bash(git branch:*)",
       "Bash(yt:*)",
-      "WebFetch(domain:pypi.org)"
+      "WebFetch(domain:pypi.org)",
+      "mcp__github__create_issue",
+      "mcp__claude-code__Read",
+      "mcp__claude-code__Grep",
+      "WebFetch(domain:github.com)"
     ],
     "deny": []
   }

{youtrack_cli-0.2.1 → youtrack_cli-0.3.0}/CLAUDE.md

@@ -22,6 +22,10 @@ For every change that is implemented, the README.md file MUST be updated to refl
 
 All tests must pass. We use `pytest` for testing, `ruff` for linting, `ty` for type checking, `tox` for running on various versions of Python. We'll utilize `zizmor` for reviewing our GitHub Actions. Pre-commit hooks ensure code quality before commits.
 
+## Documentation
+
+Documentation is available in the docs/ folder. Any new functionality should have documentation written for it there. The README.md file shoudl not be used for comprehensive documentation.
+
 ## Deploy
 
 Deployment will always be done to a feature branch. When a feature is significant enough, we'll bump the version of the tool and tag it with that version. We will have a github action that deploys this to Test PyPI and PyPI using a `release.yml` GitHub Action.

{youtrack_cli-0.2.1 → youtrack_cli-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: youtrack-cli
-Version: 0.2.1
+Version: 0.3.0
 Summary: YouTrack CLI - Command line interface for JetBrains YouTrack issue tracking system
 Project-URL: Homepage, https://github.com/ryan-murphy/yt-cli
 Project-URL: Documentation, https://yt-cli.readthedocs.io/
@@ -26,24 +26,16 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Utilities
 Requires-Python: <3.14,>=3.9
 Requires-Dist: click>=8.0.0
+Requires-Dist: cryptography>=41.0.0
 Requires-Dist: httpx>=0.24.0
+Requires-Dist: keyring>=25.0.0
 Requires-Dist: pydantic-settings>=2.0.0
 Requires-Dist: pydantic>=2.0.0
 Requires-Dist: python-dotenv>=1.0.0
 Requires-Dist: rich>=13.0.0
+Requires-Dist: structlog>=25.4.0
 Requires-Dist: textual>=0.40.0
-Provides-Extra: dev
-Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
-Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
-Requires-Dist: pytest>=7.0.0; extra == 'dev'
-Requires-Dist: ruff>=0.1.0; extra == 'dev'
-Requires-Dist: tox>=4.0.0; extra == 'dev'
-Requires-Dist: zizmor>=0.1.0; extra == 'dev'
-Provides-Extra: docs
-Requires-Dist: myst-parser>=2.0.0; extra == 'docs'
-Requires-Dist: sphinx-autobuild>=2021.3.14; extra == 'docs'
-Requires-Dist: sphinx-rtd-theme>=2.0.0; extra == 'docs'
-Requires-Dist: sphinx>=7.0.0; extra == 'docs'
+Requires-Dist: tomli>=1.2.0; python_version < '3.11'
 Description-Content-Type: text/markdown
 
 # YouTrack CLI
@@ -55,8 +47,10 @@ A powerful command line interface for JetBrains YouTrack issue tracking system.
 ## Features
 
 - **Complete YouTrack Management**: Issues, articles, projects, users, time tracking, boards, and reporting
-- **Flexible Authentication**: Secure token-based authentication with credential management
+- **Enterprise Security Features**: Command audit logging, credential encryption, token expiration warnings
+- **Flexible Authentication**: Secure token-based authentication with keyring integration
 - **Rich Output Formats**: Beautiful tables and JSON export for automation
+- **Progress Indicators**: Visual feedback for long-running operations with Rich progress bars
 - **Comprehensive Configuration**: Customizable defaults and environment-specific settings
 - **Administrative Tools**: System management, user groups, and health monitoring
 - **Developer-Friendly**: Built with modern Python practices and extensive documentation
@@ -108,8 +102,8 @@ cd yt-cli
 uv sync --dev
 uv pip install -e .
 
-# Or using pip
-pip install -e .[dev]
+# Or using pip (requires pip >= 24.0 for PEP 735 support)
+pip install -e . --group dev
 ```
 
 ### Authentication
@@ -122,6 +116,17 @@ yt auth login
 yt auth token --show
 ```
 
+### Shell Completion
+
+YouTrack CLI supports tab completion for bash, zsh, and fish shells:
+
+```bash
+# Enable shell completion (see docs for full instructions)
+yt completion bash --install
+```
+
+📖 **[Complete shell completion guide](https://yt-cli.readthedocs.io/en/latest/installation.html#shell-completion)**
+
 ### Basic Usage
 
 ```bash
@@ -134,8 +139,14 @@ yt articles create "Getting Started" --content "Welcome to our documentation"
 # Log work time
 yt time log ISSUE-123 "2h" --description "Feature development"
 
-# Generate reports
+# Generate reports with progress indicators
 yt reports burndown PROJECT-123
+
+# Disable progress indicators for automation
+yt --no-progress reports velocity PROJECT-123
+
+# Enable debug logging for troubleshooting
+yt --debug issues list
 ```
 
 ## Documentation

{youtrack_cli-0.2.1 → youtrack_cli-0.3.0}/README.md

@@ -7,8 +7,10 @@ A powerful command line interface for JetBrains YouTrack issue tracking system.
 ## Features
 
 - **Complete YouTrack Management**: Issues, articles, projects, users, time tracking, boards, and reporting
-- **Flexible Authentication**: Secure token-based authentication with credential management
+- **Enterprise Security Features**: Command audit logging, credential encryption, token expiration warnings
+- **Flexible Authentication**: Secure token-based authentication with keyring integration
 - **Rich Output Formats**: Beautiful tables and JSON export for automation
+- **Progress Indicators**: Visual feedback for long-running operations with Rich progress bars
 - **Comprehensive Configuration**: Customizable defaults and environment-specific settings
 - **Administrative Tools**: System management, user groups, and health monitoring
 - **Developer-Friendly**: Built with modern Python practices and extensive documentation
@@ -60,8 +62,8 @@ cd yt-cli
 uv sync --dev
 uv pip install -e .
 
-# Or using pip
-pip install -e .[dev]
+# Or using pip (requires pip >= 24.0 for PEP 735 support)
+pip install -e . --group dev
 ```
 
 ### Authentication
@@ -74,6 +76,17 @@ yt auth login
 yt auth token --show
 ```
 
+### Shell Completion
+
+YouTrack CLI supports tab completion for bash, zsh, and fish shells:
+
+```bash
+# Enable shell completion (see docs for full instructions)
+yt completion bash --install
+```
+
+📖 **[Complete shell completion guide](https://yt-cli.readthedocs.io/en/latest/installation.html#shell-completion)**
+
 ### Basic Usage
 
 ```bash
@@ -86,8 +99,14 @@ yt articles create "Getting Started" --content "Welcome to our documentation"
 # Log work time
 yt time log ISSUE-123 "2h" --description "Feature development"
 
-# Generate reports
+# Generate reports with progress indicators
 yt reports burndown PROJECT-123
+
+# Disable progress indicators for automation
+yt --no-progress reports velocity PROJECT-123
+
+# Enable debug logging for troubleshooting
+yt --debug issues list
 ```
 
 ## Documentation

{youtrack_cli-0.2.1 → youtrack_cli-0.3.0}/docs/changelog.rst

@@ -26,6 +26,11 @@ Added
 - **Common CLI components and decorators for consistent command behavior**
 - **User-friendly error messages with actionable suggestions**
 - **Structured exception hierarchy (AuthenticationError, ConnectionError, etc.)**
+- **Enhanced release management with comprehensive justfile recipes**
+- **Pre-flight checks for release validation and safety**
+- **Automated release rollback capabilities for emergency situations**
+- **Release status monitoring and health checks**
+- **Comprehensive release troubleshooting documentation**
 
 Changed
 ~~~~~~~
@@ -35,6 +40,9 @@ Changed
 - **Enhanced project metadata in pyproject.toml with comprehensive classifiers and URLs**
 - **Improved CLI architecture with global debug and verbose options**
 - **Updated troubleshooting documentation with new debugging features**
+- **Improved justfile release recipes with safety checks and validation**
+- **Enhanced release workflow documentation with real-world examples**
+- **Updated development documentation with automated release process**
 
 Deprecated
 ~~~~~~~~~~
@@ -46,11 +54,13 @@ Removed
 
 Fixed
 ~~~~~
-- None
+- **Release process reliability with proper git state validation**
+- **Version consistency management between pyproject.toml and package**
+- **uv.lock synchronization during release process**
 
 Security
 ~~~~~~~~
-- None
+- **Enhanced release process with branch protection and quality gates**
 
 [0.1.0] - 2024-07-02
 ---------------------

youtrack_cli-0.3.0/docs/command-aliases.rst

@@ -0,0 +1,285 @@
+================
+Command Aliases
+================
+
+YouTrack CLI provides convenient aliases for commonly used commands to improve usability and reduce typing. This document describes all available command aliases and how to use them effectively.
+
+Overview
+========
+
+Command aliases allow you to use shorter command names for frequently used operations. For example, instead of typing ``yt issues list``, you can simply use ``yt i l``.
+
+Main Command Aliases
+====================
+
+The following aliases are available for the main command groups:
+
+.. list-table:: Main Command Aliases
+   :header-rows: 1
+   :widths: 20 30 50
+
+   * - Alias
+     - Full Command
+     - Description
+   * - ``i``
+     - ``issues``
+     - Issue management commands
+   * - ``a``
+     - ``articles``
+     - Knowledge base article commands
+   * - ``p``
+     - ``projects``
+     - Project management commands
+   * - ``u``
+     - ``users``
+     - User management commands
+   * - ``t``
+     - ``time``
+     - Time tracking commands
+   * - ``b``
+     - ``boards``
+     - Agile board commands
+   * - ``c``, ``cfg``
+     - ``config``
+     - Configuration management
+   * - ``login``
+     - ``auth``
+     - Authentication commands
+
+Subcommand Aliases
+==================
+
+Within the issues command group, additional aliases are available for common operations:
+
+.. list-table:: Issues Subcommand Aliases
+   :header-rows: 1
+   :widths: 20 30 50
+
+   * - Alias
+     - Full Command
+     - Description
+   * - ``c``, ``new``
+     - ``create``
+     - Create a new issue
+   * - ``l``, ``ls``
+     - ``list``
+     - List issues
+   * - ``u``, ``edit``
+     - ``update``
+     - Update an existing issue
+   * - ``s``, ``find``
+     - ``search``
+     - Search for issues
+   * - ``d``, ``del``, ``rm``
+     - ``delete``
+     - Delete an issue
+
+Usage Examples
+==============
+
+Here are practical examples showing how to use aliases effectively:
+
+Basic Operations
+----------------
+
+Create a new issue:
+
+.. code-block:: bash
+
+   # Using full commands
+   yt issues create PROJECT-123 "Fix login bug"
+
+   # Using aliases
+   yt i c PROJECT-123 "Fix login bug"
+   yt i new PROJECT-123 "Fix login bug"
+
+List issues:
+
+.. code-block:: bash
+
+   # Using full commands
+   yt issues list --assignee me
+
+   # Using aliases
+   yt i l --assignee me
+   yt i ls --assignee me
+
+Search for issues:
+
+.. code-block:: bash
+
+   # Using full commands
+   yt issues search "priority:Critical"
+
+   # Using aliases
+   yt i s "priority:Critical"
+   yt i find "priority:Critical"
+
+Configuration Management
+------------------------
+
+.. code-block:: bash
+
+   # Using full commands
+   yt config set OUTPUT_FORMAT json
+   yt config get OUTPUT_FORMAT
+
+   # Using aliases
+   yt c set OUTPUT_FORMAT json
+   yt cfg get OUTPUT_FORMAT
+
+Authentication
+--------------
+
+.. code-block:: bash
+
+   # Using full commands
+   yt auth login
+
+   # Using aliases
+   yt login
+
+Project Management
+------------------
+
+.. code-block:: bash
+
+   # Using full commands
+   yt projects list
+
+   # Using aliases
+   yt p list
+
+Time Tracking
+-------------
+
+.. code-block:: bash
+
+   # Using full commands
+   yt time log ISSUE-123 "2h 30m" --description "Fixed the bug"
+
+   # Using aliases
+   yt t log ISSUE-123 "2h 30m" --description "Fixed the bug"
+
+Complex Workflows
+=================
+
+You can chain aliases for even more efficient workflows:
+
+Daily Issue Management:
+
+.. code-block:: bash
+
+   # Check your assigned issues
+   yt i l --assignee me --state Open
+
+   # Create a new bug report
+   yt i c WEB-123 "Mobile login issue" --type Bug --priority High
+
+   # Update issue status
+   yt i u ISSUE-456 --state "In Progress"
+
+   # Log work time
+   yt t log ISSUE-456 "1h 30m" --description "Initial investigation"
+
+Configuration and Setup:
+
+.. code-block:: bash
+
+   # Quick authentication
+   yt login
+
+   # Configure output format
+   yt c set OUTPUT_FORMAT table
+
+   # List current configuration
+   yt c list
+
+Help and Discovery
+==================
+
+All aliases work with the ``--help`` flag to show command documentation:
+
+.. code-block:: bash
+
+   # Get help for issues commands
+   yt i --help
+
+   # Get help for creating issues
+   yt i c --help
+
+   # Get help for configuration
+   yt c --help
+
+The main help command also lists all available aliases:
+
+.. code-block:: bash
+
+   yt --help
+
+Best Practices
+==============
+
+1. **Start with Full Commands**: When learning, use full command names to understand the structure.
+
+2. **Use Aliases for Frequent Operations**: Once comfortable, switch to aliases for commands you use often.
+
+3. **Mix and Match**: You can combine full commands and aliases as needed:
+
+   .. code-block:: bash
+
+      yt i create PROJECT-123 "Title"  # Mix of alias and full command
+
+4. **Shell Completion**: Aliases work with shell completion, making them even faster to use.
+
+5. **Documentation**: When sharing commands with others, consider using full names for clarity in documentation.
+
+Shell Completion
+================
+
+Aliases are fully supported by the shell completion system. After setting up completion for your shell:
+
+.. code-block:: bash
+
+   # Generate completion for bash
+   yt completion bash --install
+
+   # Generate completion for zsh
+   yt completion zsh --install
+
+   # Generate completion for fish
+   yt completion fish --install
+
+You can use tab completion with aliases just like with full commands:
+
+.. code-block:: bash
+
+   yt i <TAB>       # Shows issues subcommands
+   yt i c <TAB>     # Shows create command options
+   yt c s<TAB>      # Completes to "set"
+
+Migration Guide
+===============
+
+If you're upgrading from a version without aliases, your existing commands will continue to work unchanged. Aliases are additive and don't replace existing functionality.
+
+You can gradually adopt aliases at your own pace:
+
+1. Continue using full commands in scripts and documentation
+2. Start using aliases for interactive command-line work
+3. Update your muscle memory over time
+
+Troubleshooting
+===============
+
+If aliases don't work as expected:
+
+1. **Check Version**: Ensure you're using a version that supports aliases (v0.3.0+)
+
+2. **Verify Installation**: Run ``yt --help`` to see if aliases are listed
+
+3. **Clear Cache**: If using shell completion, you may need to restart your shell or reload completion
+
+4. **Conflict Resolution**: If an alias conflicts with another command, the original command takes precedence
+
+For additional help, see the :doc:`troubleshooting` guide or file an issue on GitHub.

{youtrack_cli-0.2.1 → youtrack_cli-0.3.0}/docs/development.rst

@@ -91,6 +91,45 @@ Project Structure
    ├── justfile               # Task runner configuration
    └── README.md              # Project overview
 
+Dependency Management
+---------------------
+
+The project uses PEP 735 dependency groups for managing development dependencies. This provides a standardized way to organize and install different sets of dependencies.
+
+Dependency Groups
+~~~~~~~~~~~~~~~~~
+
+The project defines the following dependency groups in ``pyproject.toml``:
+
+* **dev**: Development tools including testing, linting, and type checking
+* **docs**: Documentation generation tools
+
+Installing Dependencies
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Using uv (recommended):
+
+.. code-block:: bash
+
+   # Install all dependencies including dev group
+   uv sync --dev
+
+   # Install only production dependencies
+   uv sync
+
+Using pip (requires pip >= 24.0):
+
+.. code-block:: bash
+
+   # Install with dev dependencies
+   pip install -e . --group dev
+
+   # Install with docs dependencies
+   pip install -e . --group docs
+
+   # Install multiple groups
+   pip install -e . --group dev --group docs
+
 Development Workflow
 --------------------
 
@@ -508,23 +547,150 @@ Version Management
 
 The project uses semantic versioning (MAJOR.MINOR.PATCH):
 
-* MAJOR: Breaking changes
-* MINOR: New features (backward compatible)
-* PATCH: Bug fixes (backward compatible)
+* **MAJOR**: Breaking changes
+* **MINOR**: New features (backward compatible)
+* **PATCH**: Bug fixes (backward compatible)
 
-Creating Releases
-~~~~~~~~~~~~~~~~~
+Release Workflow
+~~~~~~~~~~~~~~~~
 
-1. Update version in ``pyproject.toml``
-2. Update ``CHANGELOG.md``
-3. Create and push a version tag:
+The project uses an automated release process via ``justfile`` recipes that handle all aspects of releasing.
 
-   .. code-block:: bash
+**Step 1: Pre-Release Validation**
+
+Before creating a release, validate your intended version:
+
+.. code-block:: bash
+
+   # Check if version is valid and ready for release
+   just release-check 0.2.3
+
+   # Check current project status
+   just release-status
+
+**Step 2: Automated Release**
+
+Create a complete release with safety checks:
+
+.. code-block:: bash
+
+   # Full automated release process
+   just release 0.2.3
+
+This command will:
+
+1. **Pre-flight checks**: Verify you're on main branch, working directory is clean, and up-to-date with remote
+2. **Quality checks**: Run all linting, formatting, type checking, and tests
+3. **Version bump**: Update ``pyproject.toml`` and ``uv.lock``
+4. **Commit and push**: Create version bump commit and push to main
+5. **Tag creation**: Create and push the release tag
+6. **Trigger automation**: GitHub Actions automatically builds and publishes to PyPI
+
+**Step 3: Monitor Release**
+
+The release process provides helpful links:
+
+.. code-block:: text
+
+   ✅ Release 0.2.3 created and published!
+   🔗 Monitor release progress: https://github.com/ryancheley/yt-cli/actions
+   📦 Package will be available at: https://pypi.org/project/youtrack-cli/0.2.3/
+
+Emergency Rollback
+~~~~~~~~~~~~~~~~~~
+
+If a release needs to be rolled back (before PyPI publication):
+
+.. code-block:: bash
+
+   # Emergency rollback - deletes tag and reverts version commit
+   just rollback-release 0.2.3
+
+.. warning::
+   Rollback is only effective before the package is published to PyPI. Once published, you must create a new version.
+
+Release Safety Features
+~~~~~~~~~~~~~~~~~~~~~~~
+
+The release process includes multiple safety checks:
+
+**Branch Protection**:
+  * Must be on ``main`` branch
+  * Working directory must be clean
+  * Must be up-to-date with ``origin/main``
+
+**Version Validation**:
+  * Semantic versioning format (e.g., ``1.2.3``)
+  * Version must not already exist as a tag
+  * Must be a proper version increment
+
+**Quality Gates**:
+  * All tests must pass
+  * Code must pass linting
+  * Type checking must succeed
+  * No security issues detected
+
+Manual Release Steps (Advanced)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For advanced users who need manual control:
+
+.. code-block:: bash
+
+   # Individual steps
+   just version-bump 0.2.3    # Update pyproject.toml only
+   just tag 0.2.3             # Create and push tag only
+
+   # Quality checks
+   just check                  # Run all quality checks
+
+Release Troubleshooting
+~~~~~~~~~~~~~~~~~~~~~~~
+
+**Common Issues and Solutions**:
+
+*Working directory not clean*:
+  .. code-block:: bash
+
+     # Check what files are uncommitted
+     git status
+
+     # Commit or stash changes
+     git add . && git commit -m "commit message"
+     # or
+     git stash
+
+*Not up-to-date with remote*:
+  .. code-block:: bash
+
+     git pull origin main
+
+*Quality checks failing*:
+  .. code-block:: bash
+
+     # Run individual checks to identify issues
+     just lint           # Fix linting issues
+     just format         # Fix formatting
+     just typecheck      # Fix type issues
+     just test          # Fix failing tests
+
+*Tag already exists*:
+  .. code-block:: bash
+
+     # List existing tags
+     git tag -l
+
+     # Use the next appropriate version number
+
+GitHub Actions Integration
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-      git tag -a v0.2.0 -m "Release version 0.2.0"
-      git push origin v0.2.0
+The release process automatically triggers GitHub Actions workflows:
 
-4. GitHub Actions will automatically build and publish to PyPI
+1. **Test PyPI Deployment**: Validates package and publishes to Test PyPI
+2. **PyPI Deployment**: After Test PyPI succeeds, publishes to main PyPI
+3. **GitHub Release**: Creates GitHub release with assets and attestations
+4. **Security Attestations**: Generates digital attestations for packages
 
 Contributing Guidelines
 -----------------------