janito 3.10.0__tar.gz → 3.12.0__tar.gz

{janito-3.10.0/janito.egg-info → janito-3.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: janito
-Version: 3.10.0
+Version: 3.12.0
 Summary: A new Python package called janito.
 Author-email: João Pinto <janito@ikignosis.org>
 Project-URL: Homepage, https://github.com/ikignosis/janito

janito-3.12.0/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
+   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
+pip install -e ".[dev]"
+```
+
+## Building and Installing
+
+- To build the project:
+  ```sh
+  python -m build
+  ```
+
+- To install in editable mode:
+  ```sh
+  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
+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
+   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 `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 `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.10.0 → janito-3.12.0}/docs/guides/installation.md

@@ -1,39 +1,40 @@
-# Installation Guide
-
-This guide explains how to install Janito and verify your setup.
-
-## Requirements
-
-- Python 3.10 or newer
-
-## Installation Methods
-
-You can install Janito using pip from either PyPI (for stable releases) or directly from GitHub (for the latest development version).
-
-### From PyPI (Stable)
-```bash
-pip install janito
-```
-
-### From GitHub (Development Version)
-```bash
-pip install git+git@github.com:ikignosis/janito.git
-```
-
-> For development setup and contributing, see [Developing & Extending](developing.md).
-
-## Verifying Your Installation
-
-To confirm Janito is installed correctly, run:
-
-```bash
-janito --help
-```
-
-You should see the Janito CLI help message.
-
-## Related Guides
-
-- [Configuration Guide](configuration.md)
-- [Usage Guide](using.md)
-- [Developing & Extending](developing.md)
+# Installation Guide
+
+This guide explains how to install Janito and verify your setup.
+
+## Requirements
+
+- Python 3.10 or newer
+- **Terminal**: Windows Terminal (primary supported), PowerShell, Command Prompt, or any Unicode-capable terminal emulator
+
+## Installation Methods
+
+You can install Janito using pip from either PyPI (for stable releases) or directly from GitHub (for the latest development version).
+
+### From PyPI (Stable)
+```bash
+pip install janito
+```
+
+### From GitHub (Development Version)
+```bash
+pip install git+git@github.com:ikignosis/janito.git
+```
+
+> For development setup and contributing, see [Developing & Extending](developing.md).
+
+## Verifying Your Installation
+
+To confirm Janito is installed correctly, run:
+
+```bash
+janito --help
+```
+
+You should see the Janito CLI help message.
+
+## Related Guides
+
+- [Configuration Guide](configuration.md)
+- [Usage Guide](using.md)
+- [Developing & Extending](developing.md)

{janito-3.10.0 → janito-3.12.0}/docs/guides/read-chart-examples.md

@@ -1,177 +1,181 @@
-# 📊 Read Chart Tool Examples
-
-The `read_chart` tool allows you to display various types of charts and data visualizations directly in the terminal using the rich library.
-
-## Chart Types
-
-### 1. Table Charts
-
-Display data in a formatted table:
-
-```json
-{
-  "type": "table",
-  "data": [
-    {"name": "Alice", "age": 30, "department": "Engineering"},
-    {"name": "Bob", "age": 25, "department": "Marketing"},
-    {"name": "Charlie", "age": 35, "department": "Sales"}
-  ]
-}
-```
-
-### 2. Bar Charts
-
-Display categorical data as horizontal bars:
-
-```json
-{
-  "type": "bar",
-  "data": {
-    "January": 150,
-    "February": 200,
-    "March": 175,
-    "April": 225
-  }
-}
-```
-
-### 3. Pie Charts
-
-Display proportional data as pie segments:
-
-```json
-{
-  "type": "pie",
-  "data": {
-    "Desktop": 45,
-    "Mobile": 30,
-    "Tablet": 15,
-    "Other": 10
-  }
-}
-```
-
-### 4. Line Charts
-
-Display trends over time or continuous data:
-
-```json
-{
-  "type": "line",
-  "data": [
-    {"month": 1, "revenue": 10000},
-    {"month": 2, "revenue": 12000},
-    {"month": 3, "revenue": 9500},
-    {"month": 4, "revenue": 14000}
-  ]
-}
-```
-
-## Usage Examples
-
-### Basic Usage
-
-```python
-# Simple table
-read_chart(
-    data={"type": "table", "data": [{"product": "Laptop", "price": 999}, {"product": "Mouse", "price": 25}]},
-    title="Product Catalog"
-)
-
-# Sales data bar chart
-read_chart(
-    data={"type": "bar", "data": {"2023": 50000, "2024": 75000}},
-    title="Annual Sales",
-    width=100
-)
-```
-
-### Advanced Usage
-
-```python
-# Complex pie chart with custom dimensions
-read_chart(
-    data={
-        "type": "pie",
-        "data": {
-            "AWS": 40,
-            "Azure": 30,
-            "GCP": 20,
-            "Others": 10
-        }
-    },
-    title="Cloud Provider Market Share",
-    width=120,
-    height=25
-)
-
-# Multi-series line chart
-read_chart(
-    data={
-        "type": "line",
-        "data": [
-            {"period": "Q1", "sales": 100, "expenses": 80},
-            {"period": "Q2", "sales": 120, "expenses": 90},
-            {"period": "Q3", "sales": 110, "expenses": 85},
-            {"period": "Q4", "sales": 140, "expenses": 100}
-        ]
-    },
-    title="Quarterly Performance"
-)
-```
-
-## Data Formats
-
-### Dictionary Format
-For simple key-value data:
-
-```json
-{
-  "type": "bar",
-  "data": {
-    "Category A": 100,
-    "Category B": 150,
-    "Category C": 75
-  }
-}
-```
-
-### List of Records Format
-For structured data with multiple fields:
-
-```json
-{
-  "type": "table",
-  "data": [
-    {"country": "USA", "population": 331000000, "gdp": 21427700},
-    {"country": "China", "population": 1439323776, "gdp": 14342900},
-    {"country": "Japan", "population": 126476461, "gdp": 5081770}
-  ]
-}
-```
-
-## Error Handling
-
-The tool provides helpful error messages:
-
-- **Missing data**: "⚠️ Warning: No data provided for chart"
-- **Invalid type**: "❌ Error: Unsupported chart type 'xyz'. Use: table, bar, line, pie"
-- **Import issues**: "❌ Error: rich library not available for chart display"
-
-## Integration with Janito
-
-When using Janito in chat mode, you can ask it to create visualizations:
-
-```
-User: Show me a chart of the quarterly sales data
-Janito: I'll create a bar chart for you...
-[Uses read_chart tool to display the visualization]
-```
-
-## Best Practices
-
-1. **Data Validation**: Ensure your data is properly formatted JSON
-2. **Appropriate Chart Types**: Choose the right chart type for your data
-3. **Titles**: Always provide descriptive titles
-4. **Dimensions**: Adjust width/height for better readability
+# 📊 Read Chart Tool Examples
+
+The `read_chart` tool allows you to display various types of charts and data visualizations directly in the terminal using the rich library.
+
+## Terminal Requirements
+
+For optimal chart display, use a modern Unicode-capable terminal. **Windows Terminal is the primary supported terminal** and provides the best experience. Charts use Unicode characters and colors that require terminal support for proper rendering.
+
+## Chart Types
+
+### 1. Table Charts
+
+Display data in a formatted table:
+
+```json
+{
+  "type": "table",
+  "data": [
+    {"name": "Alice", "age": 30, "department": "Engineering"},
+    {"name": "Bob", "age": 25, "department": "Marketing"},
+    {"name": "Charlie", "age": 35, "department": "Sales"}
+  ]
+}
+```
+
+### 2. Bar Charts
+
+Display categorical data as horizontal bars:
+
+```json
+{
+  "type": "bar",
+  "data": {
+    "January": 150,
+    "February": 200,
+    "March": 175,
+    "April": 225
+  }
+}
+```
+
+### 3. Pie Charts
+
+Display proportional data as pie segments:
+
+```json
+{
+  "type": "pie",
+  "data": {
+    "Desktop": 45,
+    "Mobile": 30,
+    "Tablet": 15,
+    "Other": 10
+  }
+}
+```
+
+### 4. Line Charts
+
+Display trends over time or continuous data:
+
+```json
+{
+  "type": "line",
+  "data": [
+    {"month": 1, "revenue": 10000},
+    {"month": 2, "revenue": 12000},
+    {"month": 3, "revenue": 9500},
+    {"month": 4, "revenue": 14000}
+  ]
+}
+```
+
+## Usage Examples
+
+### Basic Usage
+
+```python
+# Simple table
+read_chart(
+    data={"type": "table", "data": [{"product": "Laptop", "price": 999}, {"product": "Mouse", "price": 25}]},
+    title="Product Catalog"
+)
+
+# Sales data bar chart
+read_chart(
+    data={"type": "bar", "data": {"2023": 50000, "2024": 75000}},
+    title="Annual Sales",
+    width=100
+)
+```
+
+### Advanced Usage
+
+```python
+# Complex pie chart with custom dimensions
+read_chart(
+    data={
+        "type": "pie",
+        "data": {
+            "AWS": 40,
+            "Azure": 30,
+            "GCP": 20,
+            "Others": 10
+        }
+    },
+    title="Cloud Provider Market Share",
+    width=120,
+    height=25
+)
+
+# Multi-series line chart
+read_chart(
+    data={
+        "type": "line",
+        "data": [
+            {"period": "Q1", "sales": 100, "expenses": 80},
+            {"period": "Q2", "sales": 120, "expenses": 90},
+            {"period": "Q3", "sales": 110, "expenses": 85},
+            {"period": "Q4", "sales": 140, "expenses": 100}
+        ]
+    },
+    title="Quarterly Performance"
+)
+```
+
+## Data Formats
+
+### Dictionary Format
+For simple key-value data:
+
+```json
+{
+  "type": "bar",
+  "data": {
+    "Category A": 100,
+    "Category B": 150,
+    "Category C": 75
+  }
+}
+```
+
+### List of Records Format
+For structured data with multiple fields:
+
+```json
+{
+  "type": "table",
+  "data": [
+    {"country": "USA", "population": 331000000, "gdp": 21427700},
+    {"country": "China", "population": 1439323776, "gdp": 14342900},
+    {"country": "Japan", "population": 126476461, "gdp": 5081770}
+  ]
+}
+```
+
+## Error Handling
+
+The tool provides helpful error messages:
+
+- **Missing data**: "⚠️ Warning: No data provided for chart"
+- **Invalid type**: "❌ Error: Unsupported chart type 'xyz'. Use: table, bar, line, pie"
+- **Import issues**: "❌ Error: rich library not available for chart display"
+
+## Integration with Janito
+
+When using Janito in chat mode, you can ask it to create visualizations:
+
+```
+User: Show me a chart of the quarterly sales data
+Janito: I'll create a bar chart for you...
+[Uses read_chart tool to display the visualization]
+```
+
+## Best Practices
+
+1. **Data Validation**: Ensure your data is properly formatted JSON
+2. **Appropriate Chart Types**: Choose the right chart type for your data
+3. **Titles**: Always provide descriptive titles
+4. **Dimensions**: Adjust width/height for better readability
 5. **Data Types**: Use numeric values for bar, pie, and line charts