Skip to main content

Give your Cursor IDE Agents superpowers.

Project description

Cursor Utils

A modern CLI utility toolkit for Cursor, built with strict typing and modern Python practices.

Features

  • Modern CLI interface using Click
  • Rich terminal output
  • Comprehensive diagnostic tools
  • Fully type-annotated codebase
  • Modern Python packaging

Installation

# Using UV (recommended)
uv pip install cursor-utils

# Using pip
pip install cursor-utils

Development Setup

  1. Clone the repository:
git clone https://github.com/gweidart/cursor-utils.git
cd cursor-utils
  1. Create and activate a virtual environment:
uv venv .venv
source .venv/bin/activate  # On Unix/macOS
# or
.venv\Scripts\activate  # On Windows
  1. Install development dependencies:
uv pip sync requirements/requirements-dev.txt requirements/requirements-test.txt
  1. Install pre-commit hooks:
pre-commit install

Usage

cursor-utils --help

Development

  • Code style is enforced using black, isort, and ruff
  • Type checking is done with mypy
  • Testing is done with pytest

Packaging and Release Process

Building the Package

To build the package locally:

# Using the build module
python -m build

# Or using the provided script
python scripts/publish.py --test

Bumping the Version

To bump the version before a release:

# Bump patch version (0.0.X)
python scripts/bump_version.py patch

# Bump minor version (0.X.0)
python scripts/bump_version.py minor

# Bump major version (X.0.0)
python scripts/bump_version.py major

Publishing to PyPI

To publish to PyPI:

# Test PyPI
python scripts/publish.py --test

# Production PyPI
python scripts/publish.py

GitHub Releases

  1. Create a new tag: git tag v0.1.0
  2. Push the tag: git push origin v0.1.0
  3. Create a new release on GitHub with the tag
  4. The GitHub Actions workflow will automatically build and publish the package to PyPI

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cursor_utils-0.1.0.tar.gz (45.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cursor_utils-0.1.0-py3-none-any.whl (69.0 kB view details)

Uploaded Python 3

File details

Details for the file cursor_utils-0.1.0.tar.gz.

File metadata

  • Download URL: cursor_utils-0.1.0.tar.gz
  • Upload date:
  • Size: 45.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cursor_utils-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ded86e56f62e3c15d33d3f5c9a0e0dcedd565b4a163793b2342bfbdd234051cc
MD5 35708e49d8c22294c854d633620c463b
BLAKE2b-256 e5ab91bd26f7a875542f85210e1d3dae82979ccc3b32fd9f1b1959474ef2b26c

See more details on using hashes here.

Provenance

The following attestation bundles were made for cursor_utils-0.1.0.tar.gz:

Publisher: publish.yml on gweidart/cursor-utils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cursor_utils-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: cursor_utils-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 69.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cursor_utils-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 580c513cbc8c75ff6aa9e480c78e4a7697ae39df9442e118e15764734f38f64b
MD5 ba18a098d3ab0958de07b1dc38d978d6
BLAKE2b-256 b15db5bc346cda04557b2fa7e2a78838f57b702c0150f81ccb8b333bf68783e6

See more details on using hashes here.

Provenance

The following attestation bundles were made for cursor_utils-0.1.0-py3-none-any.whl:

Publisher: publish.yml on gweidart/cursor-utils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page