janito 3.11.0__tar.gz → 3.12.0__tar.gz

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

@@ -1,84 +1,84 @@
-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.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
+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

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.11.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)