# 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.
Raw data
{
"_id": null,
"home_page": "https://codeflash.ai",
"name": "codeflash",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "codeflash, performance, optimization, ai, code, machine learning, LLM",
"author": "CodeFlash Inc.",
"author_email": "contact@codeflash.ai",
"download_url": "https://files.pythonhosted.org/packages/39/5d/8f42ace5b1c2a4eda04d10fe0090e8628ea882c0de2b5addbc91946b63db/codeflash-0.8.4.tar.gz",
"platform": null,
"description": "# Codeflash\n\nCodeflash is an AI optimization tool that automatically improves the performance of your Python code while maintaining its correctness.\n\n![img.png](https://res.cloudinary.com/dkg30tdvl/image/upload/v1731590846/readme-img_df52le.png)\n\n## Features\n\n- Automatically optimizes your code using AI\n- Maintains code correctness through extensive testing\n- Opens a pull request for each optimization\n- Continuously optimizes your codebase through CI\n- Dynamically optimizes your real workflows through tracing\n\n## Installation\n\nTo install Codeflash, run:\n\n```\npip install codeflash\n```\n\n## Quick Start\n\n1. Configure Codeflash for your project:\n ```\n codeflash init\n ```\n\n2. Optimize a function:\n ```\n codeflash --file path/to/your/file.py --function function_name\n ```\n \n3. Optimize your entire codebase:\n ```\n codeflash --all\n ```\n\n## Getting the Best Results\n\nTo get the most out of Codeflash:\n\n1. Install the Github App and actions workflow\n2. Find optimizations on your whole codebase with codeflash --all\n3. Find and optimize bottlenecks with the Codeflash Tracer\n4. Review the PRs Codeflash opens\n\n\n## Learn More\n\n- [Codeflash Website](https://www.codeflash.ai)\n- [Documentation](https://docs.codeflash.ai)\n\n## License\n\nCodeflash is licensed under the BSL-1.1 License. See the LICENSE file for details.\n",
"bugtrack_url": null,
"license": "BSL-1.1",
"summary": "Client for codeflash.ai - automatic code performance optimization, powered by AI",
"version": "0.8.4",
"project_urls": {
"Homepage": "https://codeflash.ai"
},
"split_keywords": [
"codeflash",
" performance",
" optimization",
" ai",
" code",
" machine learning",
" llm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "395d8f42ace5b1c2a4eda04d10fe0090e8628ea882c0de2b5addbc91946b63db",
"md5": "463c82874973cac500b60fbeb322c205",
"sha256": "b137ed6f36599fe51c6fbe1988b4f7acb1c8a61c033e913b7e5fe240879258c8"
},
"downloads": -1,
"filename": "codeflash-0.8.4.tar.gz",
"has_sig": false,
"md5_digest": "463c82874973cac500b60fbeb322c205",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 96858,
"upload_time": "2024-12-18T23:58:04",
"upload_time_iso_8601": "2024-12-18T23:58:04.080805Z",
"url": "https://files.pythonhosted.org/packages/39/5d/8f42ace5b1c2a4eda04d10fe0090e8628ea882c0de2b5addbc91946b63db/codeflash-0.8.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 23:58:04",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "codeflash"
}