Skip to main content

A tool to automatically rename screenshots using OpenAI's OCR

Project description

cleanshot 📸

PyPI version License: MIT

Cleanshot monitors your macOS Screenshots folder and automatically renames screenshots using OpenAI.

Description

🔧 Installation

pip install cleanshot

🎮 Usage

Start cleanshot

cleanshot

Stop cleanshot

cleanshot stop

View help docs

cleanshot --help

⚙️ Settings

Supported LLM Providers:

  • OpenAI

You can update your API keys and provider settings by running:

cleanshot --setup

OpenAI

To use OpenAI, you need an OpenAI account and a subscription. You can create an API key on this page.

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

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

cleanshot-1.1.0.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

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

cleanshot-1.1.0-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file cleanshot-1.1.0.tar.gz.

File metadata

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

File hashes

Hashes for cleanshot-1.1.0.tar.gz
Algorithm Hash digest
SHA256 451a08f98a9c2c0e639a724127ed66692390aa2f62e53a05cd844272c0fce50d
MD5 4553a0b62132c7371ee981b3e3fbc28e
BLAKE2b-256 2b24ae4dd3e002aacdeea6338b64e0267dcae749163172953b3cc08d0b5d2d8d

See more details on using hashes here.

Provenance

The following attestation bundles were made for cleanshot-1.1.0.tar.gz:

Publisher: python-publish.yml on shlomomdahan/cleanshot

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

File details

Details for the file cleanshot-1.1.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for cleanshot-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 03ed00bde8dcca5c184b7729817e9743d3568c4b82d75da7b6b2ec7d3a84d9d2
MD5 013e8247a9b7541643034ac8b35a8a53
BLAKE2b-256 1fa2523dadcf12f0df46a477c65a9e881bca34ea56f9f9ac387e2c8cb763550b

See more details on using hashes here.

Provenance

The following attestation bundles were made for cleanshot-1.1.0-py3-none-any.whl:

Publisher: python-publish.yml on shlomomdahan/cleanshot

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