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.2.0.tar.gz (11.5 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.2.0-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cleanshot-1.2.0.tar.gz
Algorithm Hash digest
SHA256 13c2e88d47bf2e18bc4ccc67f662d1a3d6d14b97558a7bc14a58f37ad5dbef91
MD5 b236cac5238beb1d3583abf12b32c358
BLAKE2b-256 08e55e7619973e6a383251cca47fce3f3387fe047e0bde648babe03ebaa0d791

See more details on using hashes here.

Provenance

The following attestation bundles were made for cleanshot-1.2.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.2.0-py3-none-any.whl.

File metadata

  • Download URL: cleanshot-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 14.9 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fddd4f2b10eac06b24ce6f08b7a8ebcb22aadbb835b38e44d4ed461961850734
MD5 c8d960f67f51226ba119d9a6e731f515
BLAKE2b-256 761e7f89807fa629c36294178ae51024fe87786d6c799f250a9514859ffddddb

See more details on using hashes here.

Provenance

The following attestation bundles were made for cleanshot-1.2.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