A CLI-based agent for proofreading and editing short-form writing
Project description
proofer
⚠️ This is experimental and a work in progress.
A minimal, CLI-based agent built with LangGraph for proofreading and editing short-form writing like blog posts. Displays a helpful git-like diff with suggestions and the option to automatically apply changes with backups.
User Guide
OpenAI API Key
For most tasks this library uses OpenAI API's so you'll need to set the OPENAI_API_KEY environment variable. An easy way to do this is to put this line:
export OPENAI_API_KEY=<your key>
in your .zshrc file or whichever configuration file your setup uses.
Install
TODO
Usage
TODO
Development
This project currently requires Python 3.13 (pyenv is recommended) and uses Poetry as the dependency manager and packaging tool.
For now, checkout the Makefile as a guide.
| Command | Description |
|---|---|
| make install | Install all dependencies |
| make test | Run unit tests |
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file proofer-0.1.0.tar.gz.
File metadata
- Download URL: proofer-0.1.0.tar.gz
- Upload date:
- Size: 5.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.5 CPython/3.13.1 Darwin/24.5.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6b3ec4eb72803d7df04d33ff2111680c643d0a17910fffe879a9ac464feb6449
|
|
| MD5 |
89648ae2fe6f0ef2d98023ccb3084630
|
|
| BLAKE2b-256 |
f712015cd4eb7cd639fb9057ac40da8ac95a399123faaff5e4333b4953fc7497
|
File details
Details for the file proofer-0.1.0-py3-none-any.whl.
File metadata
- Download URL: proofer-0.1.0-py3-none-any.whl
- Upload date:
- Size: 7.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.5 CPython/3.13.1 Darwin/24.5.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1ff6c61ae3039e27c088a8d8584491f9297574202086b2af5a4dd88a18d85176
|
|
| MD5 |
42a12afcb105f2c1e67cdcadb07a25e0
|
|
| BLAKE2b-256 |
4594abaed2cdde368bb800256048b639259b471da3e41c28196bb858c4e5f908
|
