Metadata-Version: 2.1
Name: codeflash
Version: 0.8.4
Summary: Client for codeflash.ai - automatic code performance optimization, powered by AI
Home-page: https://codeflash.ai
License: BSL-1.1
Keywords: codeflash,performance,optimization,ai,code,machine learning,LLM
Author: CodeFlash Inc.
Author-email: contact@codeflash.ai
Requires-Python: >=3.9,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: click (>=8.1.0)
Requires-Dist: coverage (>=7.6.4)
Requires-Dist: crosshair-tool (>=0.0.78)
Requires-Dist: dill (>=0.3.8)
Requires-Dist: gitpython (>=3.1.31)
Requires-Dist: humanize (>=4.0.0)
Requires-Dist: inquirer (>=3.0.0)
Requires-Dist: isort (>=5.11.0)
Requires-Dist: jedi (>=0.19.1)
Requires-Dist: junitparser (>=3.1.0)
Requires-Dist: libcst (>=1.0.1)
Requires-Dist: lxml (>=5.3.0)
Requires-Dist: parameterized (>=0.9.0)
Requires-Dist: posthog (>=3.0.0)
Requires-Dist: pydantic (>=1.10.1)
Requires-Dist: pytest (>=7.0.0)
Requires-Dist: pytest-timeout (>=2.1.0)
Requires-Dist: rich (>=13.8.1)
Requires-Dist: sentry-sdk (>=1.40.6,<3.0.0)
Requires-Dist: tiktoken (>=0.3.2)
Requires-Dist: timeout-decorator (>=0.5.0)
Requires-Dist: tomlkit (>=0.11.7)
Requires-Dist: unidiff (>=0.7.4)
Requires-Dist: unittest-xml-reporting (>=3.2.0)
Description-Content-Type: text/markdown

# Codeflash

Codeflash is an AI optimization tool that automatically improves the performance of your Python code while maintaining its correctness.

![img.png](https://res.cloudinary.com/dkg30tdvl/image/upload/v1731590846/readme-img_df52le.png)

## Features

- Automatically optimizes your code using AI
- Maintains code correctness through extensive testing
- Opens a pull request for each optimization
- Continuously optimizes your codebase through CI
- Dynamically optimizes your real workflows through tracing

## Installation

To install Codeflash, run:

```
pip install codeflash
```

## Quick Start

1. Configure Codeflash for your project:
   ```
   codeflash init
   ```

2. Optimize a function:
   ```
   codeflash --file path/to/your/file.py --function function_name
   ```
   
3. Optimize your entire codebase:
   ```
   codeflash --all
   ```

## Getting the Best Results

To get the most out of Codeflash:

1. Install the Github App and actions workflow
2. Find optimizations on your whole codebase with codeflash --all
3. Find and optimize bottlenecks with the Codeflash Tracer
4. Review the PRs Codeflash opens


## Learn More

- [Codeflash Website](https://www.codeflash.ai)
- [Documentation](https://docs.codeflash.ai)

## License

Codeflash is licensed under the BSL-1.1 License. See the LICENSE file for details.

