Metadata-Version: 2.1
Name: autobot-ml
Version: 0.0.1
Summary: An automated code refactoring tool powered by GPT-3.
Home-page: https://github.com/charliermarsh/autobot
License: MIT
Keywords: automation,refactor,GPT-3
Author: Charlie Marsh
Author-email: charlie.r.marsh@gmail.com
Requires-Python: >=3.8,<3.11
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Dist: colorama (>=0.4.5,<0.5.0)
Requires-Dist: openai (>=0.23.0,<0.24.0)
Requires-Dist: python-dotenv (>=0.21.0,<0.22.0)
Requires-Dist: rich (>=12.5.1,<13.0.0)
Project-URL: Repository, https://github.com/charliermarsh/autobot
Description-Content-Type: text/markdown

# autobot

An automated code refactoring tool powered by GPT-3. Like GitHub Copilot, for your existing
codebase.

## Getting started

First, add a `.env` file to the root directory, with a structure like this:

```
OPENAI_ORGANIZATION=${YOUR_OPENAI_ORGANIZATION}
OPENAI_API_KEY=${YOUR_OPENAI_API_KEY}
```

Then, run `poetry install`.

## Example usage

### Removing useless object inheritance

```shell
python -m autobot useless_object_inheritance schematics/useless_object_inheritance/
```

### Removing print statements

```shell
python -m autobot print_statement schematics/print_statement/
```

### Rename `self.assertEquals` to `self.assertEqual`

```shell
python -m autobot assert_equals schematics/assert_equals/
```

### Remove unnecessary f-strings

```shell
python -m autobot unnecessary_f_strings schematics/unnecessary_f_strings/
```

### Migrating to standard library generics

```shell
python -m autobot standard_library_generics schematics/standard_library_generics/
```

## License

MIT

