Skip to content

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

copyedit_ai - Copyedit with AI

Copyedit text from the CLI using AI

Features

Core Functionality

  • Copyedit text using AI models via the command line
  • Support for multiple LLM providers through the llm library
  • Stream responses as they're generated or get complete responses
  • Read from files or stdin

LLM Configuration Management

Manage your isolated LLM configuration directly through copyedit:

  • copyedit self install - Install LLM plugins from PyPI
  • copyedit self uninstall - Uninstall LLM plugins
  • copyedit self plugins - List and manage installed plugins
  • copyedit self keys - Manage API keys for different model providers
  • copyedit self templates - Manage prompt templates
  • copyedit self models - List and configure available models
  • copyedit self aliases - Create shortcuts for frequently used models
  • copyedit self schemas - Manage stored schemas

All commands operate within copyedit's isolated configuration directory, preventing conflicts with system-wide llm installations.

Example: Adding Claude Support

# Install Anthropic plugin
copyedit self install llm-anthropic

# Set up API key
copyedit self keys set anthropic
# Enter your API key when prompted

# Create an alias for convenience
copyedit self aliases set sonnet claude-sonnet-4.5

# Use Claude to copyedit
copyedit --model sonnet article.txt

Example: Using Local Models with Ollama

# Install Ollama plugin
copyedit self install llm-ollama

# List available Ollama models
copyedit self models list

# Use a local model
copyedit --model llama3.2 draft.txt

Installation

TBD: publishing a package to PyPI.

uvx

uvx --from git+https://github.com/crossjam/copyedit_ai copyedit --help

uv

uv tool install git+https://github.com/crossjam/copyedit_ai

Usage

The CLI can be invoked using either copyedit or copyedit_ai:

copyedit --help
# or
copyedit_ai --help

The author prefers copyedit

Development

This project and it's virtual environment is managed using uv and is configured to support automatic activation of virtual environments using direnv. Development activites such as linting and testing are automated via Poe The Poet, run poe after cloning this repo.

Clone

git clone https://github.com/crossjam/copyedit_ai
cd copyedit_ai

Create a Virtual Environment

uv venv

Install Dependencies

uv sync

Run poe

poe --help

Release Management

This project uses automated release management with GitHub Actions:

Version Bumping

  • poe publish_patch - Bump patch version, commit, tag, and push
  • poe publish_minor - Bump minor version, commit, tag, and push
  • poe publish_major - Bump major version, commit, tag, and push

Release Notes

  • poe changelog - Generate changelog since last tag
  • poe release-notes - Generate release notes file

Automatic Releases

When you push a version tag (e.g., v1.0.0), the unified GitHub Actions workflow will:

  1. Test - Run tests across all supported Python versions and OS combinations
  2. Publish - Build and publish to PyPI (only if tests pass)
  3. GitHub Release - Create GitHub release with auto-generated notes and artifacts (only if PyPI publish succeeds)

This ensures a complete release pipeline where each step depends on the previous step's success.

MkDocs Documentation

  • poe docs-serve - Serve documentation locally
  • poe docs-build - Build documentation
  • poe docs-deploy - Deploy to GitHub Pages

The template includes MkDocs with material theme and automatic deployment to GitHub Pages.


gh:JnyJny/python-package-cookiecutter

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages