Metadata-Version: 2.4
Name: cleanshot
Version: 1.2.0
Summary: A tool to automatically rename screenshots using OpenAI's OCR
Author: Shlomo Dahan
License-Expression: MIT
Project-URL: Repository, https://github.com/shlomomdahan/cleanshot
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: watchdog>=6.0.0
Requires-Dist: openai>=1.76.0
Requires-Dist: python-dotenv>=1.1.0
Requires-Dist: Pillow>=11.2.1
Requires-Dist: questionary>=1.10.0
Requires-Dist: rich>=13.9.4
Provides-Extra: dev
Requires-Dist: ruff>=0.11.7; extra == "dev"
Dynamic: license-file

# cleanshot 📸

[![PyPI version](https://badge.fury.io/py/cleanshot.svg)](https://badge.fury.io/py/cleanshot)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

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

![Description](./.github/demo.gif)

## 🔧 Installation

```bash
pip install cleanshot
```

## 🎮 Usage

#### Start cleanshot

```bash
cleanshot
```

#### Stop cleanshot

```bash
cleanshot stop
```

#### View help docs

```bash
cleanshot --help
```

## ⚙️ Settings

### **Supported LLM Providers:**

- OpenAI

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

```bash
cleanshot --setup
```

### OpenAI

To use OpenAI, you need an OpenAI account and a subscription. You can create an API key on [this page](https://platform.openai.com/settings/organization/api-keys).

## 🤝 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](LICENSE) file for details.
