janito 3.11.0__tar.gz → 3.11.1__tar.gz

{janito-3.11.0 → janito-3.11.1}/.github/workflows/python-app.yml.disabled

@@ -1,35 +1,35 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
-
-name: Python application
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-
-permissions:
-  contents: read
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ["pypy3.10", "3.10", "3.11", "3.12", "3.13"]
-        
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install tox
-    - name: Test with tox
-      run: |
-        tox -e py
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python application
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["pypy3.10", "3.10", "3.11", "3.12", "3.13"]
+        
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m uv pip install --upgrade pip
+        uv pip install tox
+    - name: Test with tox
+      run: |
+        tox -e py

{janito-3.11.0 → janito-3.11.1}/PKG-INFO

@@ -1,84 +1,85 @@
-Metadata-Version: 2.4
-Name: janito
-Version: 3.11.0
-Summary: A new Python package called janito.
-Author-email: João Pinto <janito@ikignosis.org>
-Project-URL: Homepage, https://github.com/ikignosis/janito
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: attrs==25.3.0
-Requires-Dist: rich==14.0.0
-Requires-Dist: pathspec==0.12.1
-Requires-Dist: setuptools>=61.0
-Requires-Dist: pyyaml>=6.0
-Requires-Dist: jinja2>=3.0.0
-Requires-Dist: prompt_toolkit>=3.0.51
-Requires-Dist: lxml>=5.4.0
-Requires-Dist: requests>=2.32.4
-Requires-Dist: bs4>=0.0.2
-Requires-Dist: questionary>=2.0.1
-Requires-Dist: openai>=1.68.0
-Requires-Dist: Pillow>=10.0.0
-Provides-Extra: dev
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: ruff==0.11.9; extra == "dev"
-Requires-Dist: detect-secrets==1.4.0; extra == "dev"
-Requires-Dist: codespell==2.4.1; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: questionary>=2.0.1; extra == "dev"
-Requires-Dist: setuptools_scm>=8.0; extra == "dev"
-Provides-Extra: coder
-Requires-Dist: janito-coder; extra == "coder"
-Dynamic: license-file
-
-# Janito
-
-```bash
-$ janito --help
-Usage: janito <command>
-
-Interact with Nine API resources. See https://docs.nineapis.ch for the full API docs.
-
-Run "janito <command> --help" for more information on a command.
-```
-
-## Setup
-
-```bash
-# If you have go already installed
-go install github.com/ninech/janito@latest
-
-# Homebrew
-brew install ninech/taps/janito
-
-# Debian/Ubuntu
-echo "deb [trusted=yes] https://repo.nine.ch/deb/ /" | sudo tee /etc/apt/sources.list.d/repo.nine.ch.list
-sudo apt-get update
-sudo apt-get install janito
-
-# Fedora/RHEL
-cat <<EOF > /etc/yum.repos.d/repo.nine.ch.repo
-[repo.nine.ch]
-name=Nine Repo
-baseurl=https://repo.nine.ch/yum/
-enabled=1
-gpgcheck=0
-EOF
-dnf install janito
-
-# Arch
-# Install yay: https://github.com/Jguer/yay#binary
-yay --version
-yay -S janito-bin
-```
-
-For Windows users, janito is also built for arm64 and amd64. You can download the
-latest exe file from the [releases](https://github.com/ninech/janito/releases) and
-install it.
-
-## Getting started
-
-* login to the API using `janito auth login`
-* run `janito --help` to get a list of all available commands
+Metadata-Version: 2.4
+Name: janito
+Version: 3.11.1
+Summary: A new Python package called janito.
+Author-email: João Pinto <janito@ikignosis.org>
+Project-URL: Homepage, https://github.com/ikignosis/janito
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: attrs==25.3.0
+Requires-Dist: rich==14.0.0
+Requires-Dist: pathspec==0.12.1
+Requires-Dist: setuptools>=61.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: jinja2>=3.0.0
+Requires-Dist: prompt_toolkit>=3.0.51
+Requires-Dist: lxml>=5.4.0
+Requires-Dist: requests>=2.32.4
+Requires-Dist: bs4>=0.0.2
+Requires-Dist: questionary>=2.0.1
+Requires-Dist: openai>=1.68.0
+Requires-Dist: Pillow>=10.0.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: ruff==0.11.9; extra == "dev"
+Requires-Dist: detect-secrets==1.4.0; extra == "dev"
+Requires-Dist: codespell==2.4.1; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: questionary>=2.0.1; extra == "dev"
+Requires-Dist: setuptools_scm>=8.0; extra == "dev"
+Requires-Dist: mkdocs; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Requires-Dist: mkdocs-material-extensions; extra == "dev"
+Dynamic: license-file
+
+# Janito
+
+```bash
+$ janito --help
+Usage: janito <command>
+
+Interact with Nine API resources. See https://docs.nineapis.ch for the full API docs.
+
+Run "janito <command> --help" for more information on a command.
+```
+
+## Setup
+
+```bash
+# If you have go already installed
+go install github.com/ninech/janito@latest
+
+# Homebrew
+brew install ninech/taps/janito
+
+# Debian/Ubuntu
+echo "deb [trusted=yes] https://repo.nine.ch/deb/ /" | sudo tee /etc/apt/sources.list.d/repo.nine.ch.list
+sudo apt-get update
+sudo apt-get install janito
+
+# Fedora/RHEL
+cat <<EOF > /etc/yum.repos.d/repo.nine.ch.repo
+[repo.nine.ch]
+name=Nine Repo
+baseurl=https://repo.nine.ch/yum/
+enabled=1
+gpgcheck=0
+EOF
+dnf install janito
+
+# Arch
+# Install yay: https://github.com/Jguer/yay#binary
+yay --version
+yay -S janito-bin
+```
+
+For Windows users, janito is also built for arm64 and amd64. You can download the
+latest exe file from the [releases](https://github.com/ninech/janito/releases) and
+install it.
+
+## Getting started
+
+* login to the API using `janito auth login`
+* run `janito --help` to get a list of all available commands

janito-3.11.1/README-dev.md

@@ -0,0 +1,164 @@
+# Developer README for janito
+
+This document provides guidelines and instructions for developers contributing to the `janito` project.
+
+## Version Management
+
+- The project uses [setuptools_scm](https://github.com/pypa/setuptools_scm) for automatic version management.
+
+- Do **not** manually set the version in any Python file or in `pyproject.toml`.
+
+- The version is derived from your latest Git tag. To update the version, create a new tag:
+  ```sh
+  git tag vX.Y.Z
+  git push --tags
+  ```
+
+- The `__version__` attribute is available via `janito.__version__`.
+
+## Project Structure
+
+- Source code is in the `janito/` directory.
+- Entry points and CLI are defined in `janito/__main__.py`.
+- Tests should be placed in a `tests/` directory (create if missing).
+
+## Dependencies
+
+- Runtime dependencies are listed in `requirements.txt`.
+- Development dependencies are in `requirements-dev.txt`.
+- Dependencies are dynamically loaded via `pyproject.toml`.
+
+### Virtual Environment Benefits
+
+Using a virtual environment ensures:
+
+- Isolated dependencies that won't conflict with system packages
+- Reproducible development environment across different machines
+- Easy cleanup - just delete the `venv` directory if needed
+- Consistent Python version and package versions for all contributors
+
+## Development Environment Setup
+
+### Using Python Virtual Environment (Recommended)
+
+1. **Create and activate a virtual environment:**
+   ```sh
+   # Create virtual environment
+   python -m venv venv
+   
+   # Activate it
+   source venv/bin/activate  # On Linux/Mac
+   # or
+   venv\Scripts\activate  # On Windows
+   ```
+
+2. **Install development dependencies:**
+   ```sh
+   # Install the package in editable mode with dev dependencies
+   uv pip install -e ".[dev]"
+   ```
+
+3. **Verify installation:**
+   ```sh
+   python -c "import janito; print(janito.__version__)"
+   ```
+
+### Alternative: System-wide Installation
+
+If you prefer not to use a virtual environment:
+
+```sh
+uv pip install -e ".[dev]"
+```
+
+## Building and Installing
+
+- To build the project:
+  ```sh
+  python -m build
+  ```
+
+- To install in editable mode:
+  ```sh
+  uv pip install -e .
+  ```
+
+## Release Process
+
+The project includes an automated release script at `tools/release.py` that handles the complete release process:
+
+- **Full release** (build + upload to PyPI):
+  ```sh
+  python tools/release.py
+  ```
+
+- **Build only** (skip PyPI upload):
+  ```sh
+  python tools/release.py --build-only
+  ```
+
+The release script will:
+
+1. Check for uncommitted changes
+2. Verify the latest git tag version
+3. Check PyPI for existing versions
+4. Build the package using `python -m build`
+5. Upload to PyPI using `twine upload`
+
+Make sure you have `build` and `twine` installed:
+
+```sh
+uv pip install build twine
+```
+
+## Running Tests
+
+- (Add test instructions here if/when tests are present)
+
+## Development Workflow Tips
+
+### Keeping Your Environment Clean
+
+1. **Always activate your virtual environment before working:**
+   ```sh
+   source venv/bin/activate  # Linux/Mac
+   venv\Scripts\activate     # Windows
+   ```
+
+2. **Update dependencies when pulling new changes:**
+   ```sh
+   uv pip install -e ".[dev]" --upgrade
+   ```
+
+3. **Deactivate virtual environment when done:**
+   ```sh
+   deactivate
+   ```
+
+### Common Virtual Environment Issues
+
+- **"Command not found" errors**: Make sure the virtual environment is activated
+- **Import errors**: Reinstall the package with `uv pip install -e ".[dev]"`
+- **Permission errors**: Use virtual environment instead of system-wide installation
+
+## Contributing
+
+- Follow PEP8 and use [ruff](https://github.com/charliermarsh/ruff) for linting.
+- Document all public functions and classes.
+- Update this README-dev.md as needed for developer-facing changes.
+
+## Quick Start Checklist
+
+For new developers getting started:
+
+1. **Clone the repository**
+2. **Create and activate virtual environment** (see [Development Environment Setup](#development-environment-setup))
+3. **Install development dependencies** with `uv pip install -e ".[dev]"`
+4. **Verify installation** with `python -c "import janito; print(janito.__version__)"`
+5. **Run tests** (when available) to ensure everything works
+6. **Start coding!**
+
+---
+
+For more information, see the main `README.md` or contact the maintainers.
+

{janito-3.11.0 → janito-3.11.1}/RELEASE_COMPARISON.md

@@ -1,118 +1,118 @@
-# Janito Release Comparison: v2.21.0 vs v2.22.0
-
-## 📊 Side-by-Side Overview
-
-| Aspect | v2.21.0 | v2.22.0 |
-|--------|---------|---------|
-| **Release Date** | August 12, 2025 | August 14, 2025 |
-| **Primary Focus** | IBM WatsonX Provider Foundation | IBM WatsonX Enhancement + Market Analysis |
-| **New Providers** | IBM WatsonX (initial) | IBM WatsonX (enhanced) |
-| **New Profiles** | - | Market Analyst Profile |
-| **Documentation** | Basic IBM setup | Comprehensive guides + market data |
-
-## 🚀 Feature Comparison
-
-### New Features
-
-#### v2.21.0
-- **IBM WatsonX Provider**: Initial implementation with basic Granite, Llama, and Mistral models
-- **Enhanced fetch_url**: Added configurable limits (max_length, max_lines, context_chars)
-- **Environment Variables**: Added examples for all providers
-- **Model Lists**: Updated OpenAI, Anthropic, and Google provider models
-
-#### v2.22.0
-- **IBM WatsonX Enhancement**: Complete provider with enterprise-grade models
-- **Market Analyst Profile**: Specialized for financial analysis workflows
-- **Enhanced fetch_url**: Added error caching for 403/404 responses
-- **Comprehensive Documentation**: Complete setup guides and market data sources
-
-### Documentation Improvements
-
-#### v2.21.0
-- Basic IBM WatsonX setup guide (`janito/providers/ibm/README.md`)
-- Updated GETTING_STARTED.md with IBM instructions
-- Environment variable examples
-
-#### v2.22.0
-- **New Guides**:
-  - `docs/ibm-setup.md` - Complete step-by-step IBM configuration
-  - `docs/guides/market-data-sources.md` - Public financial data sources
-  - `docs/guides/stock-market-guide.md` - Stock market analysis workflows
-  - `docs/public-sources.md` - Comprehensive public data sources
-- **Enhanced Documentation**: Updated all provider comparisons and model listings
-
-## 🔧 Technical Improvements
-
-### Code Changes
-
-#### v2.21.0
-- **Files Modified**: 9 files, +306/-36 lines
-- **Focus**: IBM provider foundation and fetch_url enhancements
-- **Complexity**: Reduced fetch_url complexity by splitting into helper methods
-
-#### v2.22.0
-- **Files Modified**: 14 files, +732/-29 lines
-- **Focus**: IBM enhancement, market analyst profile, and comprehensive documentation
-- **Bug Fixes**: Profile template path resolution
-- **Performance**: fetch_url error caching for better reliability
-
-### Provider Capabilities
-
-#### v2.21.0 IBM WatsonX
-- Basic model support (Granite, Llama, Mistral)
-- Initial configuration setup
-- Basic authentication handling
-
-#### v2.22.0 IBM WatsonX
-- **Enhanced Model Support**: IBM Granite enterprise models + open-source models
-- **Complete Setup Guide**: Step-by-step configuration with examples
-- **Enterprise Integration**: Better suited for business and financial analysis
-
-## 🎯 Usage Evolution
-
-### v2.21.0 Usage
-```bash
-# Basic IBM setup
-janito config set provider ibm
-janito config set model ibm/granite-3-8b-instruct
-```
-
-### v2.22.0 Usage
-```bash
-# Enhanced IBM setup with market analysis
-janito config set provider ibm
-janito config set model ibm/granite-3-8b-instruct
-janito --profile market_analyst "Analyze AAPL stock performance"
-```
-
-## 📈 Impact Summary
-
-### v2.21.0 Impact
-- **Foundation**: Established IBM WatsonX as a supported provider
-- **Technical**: Improved URL fetching capabilities
-- **Documentation**: Basic setup instructions
-
-### v2.22.0 Impact
-- **Specialization**: Added domain-specific profile for financial analysis
-- **Completeness**: Comprehensive IBM WatsonX integration
-- **Usability**: Rich documentation for market analysis workflows
-- **Reliability**: Enhanced error handling in URL fetching
-
-## 🔄 Migration Path
-
-Both versions are fully backward compatible. Users can upgrade seamlessly:
-
-```bash
-# From any previous version
-pip install --upgrade janito
-
-# New capabilities immediately available
-janito --profile market_analyst "help with stock analysis"
-```
-
-## 🎉 Summary
-
-- **v2.21.0**: Laid the foundation with IBM WatsonX support
-- **v2.22.0**: Built upon that foundation with specialized market analysis capabilities and comprehensive documentation
-
+# Janito Release Comparison: v2.21.0 vs v2.22.0
+
+## 📊 Side-by-Side Overview
+
+| Aspect | v2.21.0 | v2.22.0 |
+|--------|---------|---------|
+| **Release Date** | August 12, 2025 | August 14, 2025 |
+| **Primary Focus** | IBM WatsonX Provider Foundation | IBM WatsonX Enhancement + Market Analysis |
+| **New Providers** | IBM WatsonX (initial) | IBM WatsonX (enhanced) |
+| **New Profiles** | - | Market Analyst Profile |
+| **Documentation** | Basic IBM setup | Comprehensive guides + market data |
+
+## 🚀 Feature Comparison
+
+### New Features
+
+#### v2.21.0
+- **IBM WatsonX Provider**: Initial implementation with basic Granite, Llama, and Mistral models
+- **Enhanced fetch_url**: Added configurable limits (max_length, max_lines, context_chars)
+- **Environment Variables**: Added examples for all providers
+- **Model Lists**: Updated OpenAI, Anthropic, and Google provider models
+
+#### v2.22.0
+- **IBM WatsonX Enhancement**: Complete provider with enterprise-grade models
+- **Market Analyst Profile**: Specialized for financial analysis workflows
+- **Enhanced fetch_url**: Added error caching for 403/404 responses
+- **Comprehensive Documentation**: Complete setup guides and market data sources
+
+### Documentation Improvements
+
+#### v2.21.0
+- Basic IBM WatsonX setup guide (`janito/providers/ibm/README.md`)
+- Updated GETTING_STARTED.md with IBM instructions
+- Environment variable examples
+
+#### v2.22.0
+- **New Guides**:
+  - `docs/ibm-setup.md` - Complete step-by-step IBM configuration
+  - `docs/guides/market-data-sources.md` - Public financial data sources
+  - `docs/guides/stock-market-guide.md` - Stock market analysis workflows
+  - `docs/public-sources.md` - Comprehensive public data sources
+- **Enhanced Documentation**: Updated all provider comparisons and model listings
+
+## 🔧 Technical Improvements
+
+### Code Changes
+
+#### v2.21.0
+- **Files Modified**: 9 files, +306/-36 lines
+- **Focus**: IBM provider foundation and fetch_url enhancements
+- **Complexity**: Reduced fetch_url complexity by splitting into helper methods
+
+#### v2.22.0
+- **Files Modified**: 14 files, +732/-29 lines
+- **Focus**: IBM enhancement, market analyst profile, and comprehensive documentation
+- **Bug Fixes**: Profile template path resolution
+- **Performance**: fetch_url error caching for better reliability
+
+### Provider Capabilities
+
+#### v2.21.0 IBM WatsonX
+- Basic model support (Granite, Llama, Mistral)
+- Initial configuration setup
+- Basic authentication handling
+
+#### v2.22.0 IBM WatsonX
+- **Enhanced Model Support**: IBM Granite enterprise models + open-source models
+- **Complete Setup Guide**: Step-by-step configuration with examples
+- **Enterprise Integration**: Better suited for business and financial analysis
+
+## 🎯 Usage Evolution
+
+### v2.21.0 Usage
+```bash
+# Basic IBM setup
+janito config set provider ibm
+janito config set model ibm/granite-3-8b-instruct
+```
+
+### v2.22.0 Usage
+```bash
+# Enhanced IBM setup with market analysis
+janito config set provider ibm
+janito config set model ibm/granite-3-8b-instruct
+janito --profile market_analyst "Analyze AAPL stock performance"
+```
+
+## 📈 Impact Summary
+
+### v2.21.0 Impact
+- **Foundation**: Established IBM WatsonX as a supported provider
+- **Technical**: Improved URL fetching capabilities
+- **Documentation**: Basic setup instructions
+
+### v2.22.0 Impact
+- **Specialization**: Added domain-specific profile for financial analysis
+- **Completeness**: Comprehensive IBM WatsonX integration
+- **Usability**: Rich documentation for market analysis workflows
+- **Reliability**: Enhanced error handling in URL fetching
+
+## 🔄 Migration Path
+
+Both versions are fully backward compatible. Users can upgrade seamlessly:
+
+```bash
+# From any previous version
+uv pip install --upgrade janito
+
+# New capabilities immediately available
+janito --profile market_analyst "help with stock analysis"
+```
+
+## 🎉 Summary
+
+- **v2.21.0**: Laid the foundation with IBM WatsonX support
+- **v2.22.0**: Built upon that foundation with specialized market analysis capabilities and comprehensive documentation
+
 The progression from v2.21.0 to v2.22.0 represents a shift from basic provider support to domain-specific specialization, making Janito more valuable for financial analysis and market research use cases.