batchwizard 0.1.0__tar.gz → 0.4.0__tar.gz

batchwizard-0.4.0/.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v5
+      - run: uv sync --group dev
+      - run: uv run ruff check src/
+      - run: uv run ruff format --check src/
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: uv sync --group dev
+      # No test suite exists yet; run pytest only if tests/ appears.
+      # Remove the guard once tests land (Phase 2).
+      - run: |
+          if [ -d tests ]; then
+            uv run pytest tests/
+          else
+            echo "No tests directory yet — skipping."
+          fi
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v5
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/

batchwizard-0.4.0/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v5
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      # Required for PyPI Trusted Publishing (OIDC) — no API token needed
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

batchwizard-0.4.0/.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

batchwizard-0.4.0/PKG-INFO

@@ -0,0 +1,248 @@
+Metadata-Version: 2.4
+Name: batchwizard
+Version: 0.4.0
+Summary: BatchWizard: Manage OpenAI batch processing jobs with ease
+Project-URL: Homepage, https://github.com/cmakafui/batchwizard
+Project-URL: Repository, https://github.com/cmakafui/batchwizard
+Project-URL: Issues, https://github.com/cmakafui/batchwizard/issues
+Author: Carl Kugblenu
+License-Expression: MIT
+License-File: LICENSE
+Keywords: async,batch,cli,openai
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Requires-Dist: aiofiles>=24.1
+Requires-Dist: loguru>=0.7
+Requires-Dist: openai>=1.37
+Requires-Dist: pydantic-settings>=2.3
+Requires-Dist: pydantic>=2.8
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: rich>=13.7
+Requires-Dist: typer>=0.12
+Description-Content-Type: text/markdown
+
+# BatchWizard
+
+BatchWizard is a powerful CLI tool for managing OpenAI batch processing jobs with ease. It provides functionalities to upload files, create batch jobs, check their status, and download the results. The tool uses asynchronous processing to efficiently handle multiple jobs concurrently.
+
+![image](https://github.com/user-attachments/assets/8084afbd-fd05-43b3-b57c-2ea1eb70a457)
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Configuration](#configuration)
+- [Commands](#commands)
+- [Features](#features)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+You can install BatchWizard using `pipx` for an isolated environment or directly via `pip`.
+
+### Using pipx (recommended)
+
+```bash
+pipx install batchwizard
+```
+
+### Using pip
+
+```bash
+pip install batchwizard
+```
+
+Ensure you have `pipx` or `pip` installed on your system. For `pipx`, you can follow the installation instructions [here](https://pipx.pypa.io/stable/installation/).
+
+## Usage
+
+BatchWizard provides a command-line interface (CLI) for managing batch jobs. Here are some example commands:
+
+### Process Batch Jobs
+
+To process input files or directories:
+
+```bash
+batchwizard process <input_paths>... [--output-directory OUTPUT_DIR] [--max-concurrent-jobs NUM] [--check-interval SECONDS]
+```
+
+You can provide multiple input paths, which can be individual JSONL files or directories containing JSONL files.
+
+#### Example with Sample Input
+
+Let's say you have a file named `batchinput.jsonl` with the following content:
+
+```jsonl
+{"custom_id": "request-1", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-4o-mini", "messages": [{"role": "system", "content": "You are a helpful assistant."},{"role": "user", "content": "Hello world!"}],"max_tokens": 1000}}
+{"custom_id": "request-2", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-4o-mini", "messages": [{"role": "system", "content": "You are an unhelpful assistant."},{"role": "user", "content": "Hello world!"}],"max_tokens": 1000}}
+```
+
+To process this file using BatchWizard:
+
+1. First, ensure your OpenAI API key is set:
+   ```bash
+   batchwizard configure --set-key YOUR_API_KEY
+   ```
+2. Then, run the process command:
+   ```bash
+   batchwizard process /path/to/batchinput.jsonl --output-directory /path/to/output
+   ```
+   This command will:
+   - Upload the `batchinput.jsonl` file to OpenAI
+   - Create a batch job
+   - Monitor the job status
+   - Download the results to the specified output directory when complete
+
+You can also process multiple files or directories:
+
+```bash
+batchwizard process /path/to/file1.jsonl /path/to/directory_with_jsonl_files /path/to/file2.jsonl
+```
+
+### Submit Without Blocking (fire and forget)
+
+`process` blocks until every batch completes — which can take up to 24 hours. To submit and get your terminal back:
+
+```bash
+batchwizard submit /path/to/inputs/           # or: batchwizard process ... --submit-only
+```
+
+Submitted jobs are recorded in a local manifest (SQLite, in the BatchWizard config directory). Later — even after a reboot — reattach with:
+
+```bash
+batchwizard watch [--output-directory OUTPUT_DIR]
+```
+
+`watch` picks up every pending job from the manifest, polls until completion, and downloads the results.
+
+### Check Tracked Jobs
+
+```bash
+batchwizard status [--all]
+```
+
+Shows pending jobs from the local manifest (`--all` includes finished ones), with any failure reasons.
+
+### Failure Reasons and Error Files
+
+When a batch fails, BatchWizard surfaces the provider's actual error (e.g. `insufficient_funds`, `invalid_request` with the offending line). When individual requests inside a batch fail, the per-request error file is downloaded alongside the results as `<batch_id>_errors.jsonl`.
+
+### Batch Endpoints
+
+By default requests go to `/v1/chat/completions`. Use `--endpoint` on `process`/`submit` for other batch-capable endpoints such as `/v1/responses` or `/v1/embeddings`.
+
+### List Recent Jobs
+
+To list recent batch jobs from the provider:
+
+```bash
+batchwizard list-jobs [--limit NUM]
+```
+
+### Cancel a Job
+
+To cancel a specific batch job:
+
+```bash
+batchwizard cancel <job_id>
+```
+
+### Download Job Results
+
+To download results for a completed batch job:
+
+```bash
+batchwizard download <job_id> [--output-directory OUTPUT_DIR]
+```
+
+This downloads the results file and, if any requests failed, the per-request error file.
+
+## Configuration
+
+### Setting up the OpenAI API Key
+
+To set the OpenAI API key:
+
+```bash
+batchwizard configure --set-key YOUR_API_KEY
+```
+
+### Show Current Configuration
+
+To show the current configuration:
+
+```bash
+batchwizard configure --show
+```
+
+### Reset Configuration
+
+To reset the configuration to default values:
+
+```bash
+batchwizard configure --reset
+```
+
+## Commands
+
+BatchWizard supports the following commands:
+
+- `process`: Submit batch jobs and wait for completion (add `--submit-only` to return immediately).
+- `submit`: Submit batch jobs and exit; jobs are tracked in the local manifest.
+- `watch`: Reattach to pending jobs, poll, and download results.
+- `status`: Show jobs tracked in the local manifest.
+- `configure`: Manage BatchWizard configuration.
+- `list-jobs`: List recent batch jobs from the provider.
+- `cancel`: Cancel a specific batch job.
+- `download`: Download results (and error file) for a batch job.
+
+For detailed information on each command, use the `--help` option:
+
+```bash
+batchwizard <command> --help
+```
+
+## Features
+
+- **Flexible Input**: Process individual JSONL files or entire directories containing JSONL files.
+- **Asynchronous Processing**: Efficiently handle multiple batch jobs concurrently.
+- **Rich UI**: Display progress and job status using a rich, interactive interface.
+- **Flexible Configuration**: Easily manage API keys and other settings.
+- **Job Management**: List, cancel, and download results for batch jobs.
+- **Error Handling**: Robust error handling and informative error messages.
+
+## Contributing
+
+We welcome contributions to BatchWizard! To contribute, follow these steps:
+
+1. Fork the repository.
+2. Create a new branch: `git checkout -b feature/your-feature-name`.
+3. Make your changes and commit them: `git commit -m 'Add some feature'`.
+4. Push to the branch: `git push origin feature/your-feature-name`.
+5. Open a pull request.
+
+### Running Tests
+
+To run tests, use `pytest`:
+
+```bash
+uv run pytest tests/
+```
+
+Ensure your code passes all tests and meets the coding standards before opening a pull request.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contact
+
+For any questions or feedback, feel free to open an issue on the [GitHub repository](https://github.com/cmakafui/batchwizard).

batchwizard-0.4.0/README.md

@@ -0,0 +1,218 @@
+# BatchWizard
+
+BatchWizard is a powerful CLI tool for managing OpenAI batch processing jobs with ease. It provides functionalities to upload files, create batch jobs, check their status, and download the results. The tool uses asynchronous processing to efficiently handle multiple jobs concurrently.
+
+![image](https://github.com/user-attachments/assets/8084afbd-fd05-43b3-b57c-2ea1eb70a457)
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Configuration](#configuration)
+- [Commands](#commands)
+- [Features](#features)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+You can install BatchWizard using `pipx` for an isolated environment or directly via `pip`.
+
+### Using pipx (recommended)
+
+```bash
+pipx install batchwizard
+```
+
+### Using pip
+
+```bash
+pip install batchwizard
+```
+
+Ensure you have `pipx` or `pip` installed on your system. For `pipx`, you can follow the installation instructions [here](https://pipx.pypa.io/stable/installation/).
+
+## Usage
+
+BatchWizard provides a command-line interface (CLI) for managing batch jobs. Here are some example commands:
+
+### Process Batch Jobs
+
+To process input files or directories:
+
+```bash
+batchwizard process <input_paths>... [--output-directory OUTPUT_DIR] [--max-concurrent-jobs NUM] [--check-interval SECONDS]
+```
+
+You can provide multiple input paths, which can be individual JSONL files or directories containing JSONL files.
+
+#### Example with Sample Input
+
+Let's say you have a file named `batchinput.jsonl` with the following content:
+
+```jsonl
+{"custom_id": "request-1", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-4o-mini", "messages": [{"role": "system", "content": "You are a helpful assistant."},{"role": "user", "content": "Hello world!"}],"max_tokens": 1000}}
+{"custom_id": "request-2", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-4o-mini", "messages": [{"role": "system", "content": "You are an unhelpful assistant."},{"role": "user", "content": "Hello world!"}],"max_tokens": 1000}}
+```
+
+To process this file using BatchWizard:
+
+1. First, ensure your OpenAI API key is set:
+   ```bash
+   batchwizard configure --set-key YOUR_API_KEY
+   ```
+2. Then, run the process command:
+   ```bash
+   batchwizard process /path/to/batchinput.jsonl --output-directory /path/to/output
+   ```
+   This command will:
+   - Upload the `batchinput.jsonl` file to OpenAI
+   - Create a batch job
+   - Monitor the job status
+   - Download the results to the specified output directory when complete
+
+You can also process multiple files or directories:
+
+```bash
+batchwizard process /path/to/file1.jsonl /path/to/directory_with_jsonl_files /path/to/file2.jsonl
+```
+
+### Submit Without Blocking (fire and forget)
+
+`process` blocks until every batch completes — which can take up to 24 hours. To submit and get your terminal back:
+
+```bash
+batchwizard submit /path/to/inputs/           # or: batchwizard process ... --submit-only
+```
+
+Submitted jobs are recorded in a local manifest (SQLite, in the BatchWizard config directory). Later — even after a reboot — reattach with:
+
+```bash
+batchwizard watch [--output-directory OUTPUT_DIR]
+```
+
+`watch` picks up every pending job from the manifest, polls until completion, and downloads the results.
+
+### Check Tracked Jobs
+
+```bash
+batchwizard status [--all]
+```
+
+Shows pending jobs from the local manifest (`--all` includes finished ones), with any failure reasons.
+
+### Failure Reasons and Error Files
+
+When a batch fails, BatchWizard surfaces the provider's actual error (e.g. `insufficient_funds`, `invalid_request` with the offending line). When individual requests inside a batch fail, the per-request error file is downloaded alongside the results as `<batch_id>_errors.jsonl`.
+
+### Batch Endpoints
+
+By default requests go to `/v1/chat/completions`. Use `--endpoint` on `process`/`submit` for other batch-capable endpoints such as `/v1/responses` or `/v1/embeddings`.
+
+### List Recent Jobs
+
+To list recent batch jobs from the provider:
+
+```bash
+batchwizard list-jobs [--limit NUM]
+```
+
+### Cancel a Job
+
+To cancel a specific batch job:
+
+```bash
+batchwizard cancel <job_id>
+```
+
+### Download Job Results
+
+To download results for a completed batch job:
+
+```bash
+batchwizard download <job_id> [--output-directory OUTPUT_DIR]
+```
+
+This downloads the results file and, if any requests failed, the per-request error file.
+
+## Configuration
+
+### Setting up the OpenAI API Key
+
+To set the OpenAI API key:
+
+```bash
+batchwizard configure --set-key YOUR_API_KEY
+```
+
+### Show Current Configuration
+
+To show the current configuration:
+
+```bash
+batchwizard configure --show
+```
+
+### Reset Configuration
+
+To reset the configuration to default values:
+
+```bash
+batchwizard configure --reset
+```
+
+## Commands
+
+BatchWizard supports the following commands:
+
+- `process`: Submit batch jobs and wait for completion (add `--submit-only` to return immediately).
+- `submit`: Submit batch jobs and exit; jobs are tracked in the local manifest.
+- `watch`: Reattach to pending jobs, poll, and download results.
+- `status`: Show jobs tracked in the local manifest.
+- `configure`: Manage BatchWizard configuration.
+- `list-jobs`: List recent batch jobs from the provider.
+- `cancel`: Cancel a specific batch job.
+- `download`: Download results (and error file) for a batch job.
+
+For detailed information on each command, use the `--help` option:
+
+```bash
+batchwizard <command> --help
+```
+
+## Features
+
+- **Flexible Input**: Process individual JSONL files or entire directories containing JSONL files.
+- **Asynchronous Processing**: Efficiently handle multiple batch jobs concurrently.
+- **Rich UI**: Display progress and job status using a rich, interactive interface.
+- **Flexible Configuration**: Easily manage API keys and other settings.
+- **Job Management**: List, cancel, and download results for batch jobs.
+- **Error Handling**: Robust error handling and informative error messages.
+
+## Contributing
+
+We welcome contributions to BatchWizard! To contribute, follow these steps:
+
+1. Fork the repository.
+2. Create a new branch: `git checkout -b feature/your-feature-name`.
+3. Make your changes and commit them: `git commit -m 'Add some feature'`.
+4. Push to the branch: `git push origin feature/your-feature-name`.
+5. Open a pull request.
+
+### Running Tests
+
+To run tests, use `pytest`:
+
+```bash
+uv run pytest tests/
+```
+
+Ensure your code passes all tests and meets the coding standards before opening a pull request.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contact
+
+For any questions or feedback, feel free to open an issue on the [GitHub repository](https://github.com/cmakafui/batchwizard).