You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Note: We use [pip-tools](https://pypi.org/project/pip-tools/) to manage our the production dependencies, so if you want to add a new dependency, add it to [requirements.in](requirements/requirements.in) and then run `pip-compile requirements/requirements.in` to update [requirements.txt](requirements/requirements.txt).
72
72
73
-
4.**Use aicodebot to build aicodebot** 😎 Doing so can be a little tricky, when you are developing from the local repo you can run `python -m aicodebot.cli $command` to run/test your changes. This will use the local version of aicodebot instead of the version installed via pip
73
+
4.**Use aicodebot to build aicodebot** 😎 Doing so can be a little tricky, when you are developing from the local repository you can run `python -m aicodebot.cli $command` to run/test your changes. This will use the local version of aicodebot instead of the version installed via pip
74
74
75
-
```
75
+
```bash
76
76
python -m aicodebot.cli --help
77
77
```
78
78
@@ -85,7 +85,9 @@ Pro-tips:
85
85
86
86
We're obsessive about automated tooling, as you can imagine. 😎
87
87
88
-
We use pre-commit to run a bunch of checks on the code before it gets committed. After you've installed the dev requirements file with `pip install -r requirements/requirements-dev.txt`, you can run `pre-commit install` to install the git hook. This will run the checks on every commit. If you want to run the checks manually, you can run `pre-commit run --all-files`. If you want to skip the checks, you can run `git commit --no-verify`, but it's also as part of the [GitHub Actions build workflow](.github/workflows/build.yml), so you'll get caught there.
88
+
We use pre-commit to run a bunch of checks on the code before it gets committed. After you've installed the dev requirements file with `pip install -r requirements/requirements-dev.txt`, you can run `pre-commit install` to install the git hook. This will run the checks on every commit.
89
+
90
+
If you want to run the checks manually, you can run `pre-commit run --all-files`. If you want to skip the checks, you can run `git commit --no-verify`, but it's also as part of the [GitHub Actions build workflow](.github/workflows/build.yml), so you'll get caught there.
89
91
90
92
We use [Ruff](https://github.com/astral-sh/ruff) as our main linter. Ruff runs all the other underlying favorite tools like pylint and flake8 with a centralized config. We [black](https://black.readthedocs.io/en/stable/) for formatting, and isort for imports. See [pyproject.toml](pyproject.toml) for the config.
91
93
@@ -94,7 +96,7 @@ Highly recommend you set up your editor to run all of these on each file save, i
94
96
### Testing
95
97
96
98
Install the test dependencies with
97
-
`pip install -r requirements/requirements-test.txt` - this is what is used in the [Github Actions workflow](https://github.com/novara-ai/AICodeBot/actions), you can look at the [build workflow](.github/workflows/build.yml) to see how to run the tests.
99
+
`pip install -r requirements/requirements-test.txt` - this is what is used in the [GitHub Actions workflow](https://github.com/novara-ai/AICodeBot/actions), you can look at the [build workflow](.github/workflows/build.yml) to see how to run the tests.
98
100
99
101
We use `pytest` for testing. It will skip some tests if OPENAI_API_KEY is not set, so to test everything, run pytest with your OPENAI_API_KEY set.
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ We're using AICodeBot to build AICodeBot, and it's getting better all the time.
16
16
17
17
`aicodebot` is a tool for developers, not a replacement for them. It's not going to replace your job, but it will make your job easier and more fun. It's not going to take over the world, but it will help us build a better one. See the *Alignment* section below for more.
18
18
19
-
It's also not a "build a website for me in 5 minutes" tool that takes a well constructed prompt and builds a scaffold for you. There are [other tools](https://github.com/AntonOsika/gpt-engineer) for that, Instead, AICodeBot is built to work with existing code bases and help you improve them at the git-commit level. It's designed to multiply the effectiveness of capable engineers.
19
+
It's also not a "build a site for me in 5 minutes" tool that takes a well constructed prompt and builds a scaffold for you. There are [other tools](https://github.com/AntonOsika/gpt-engineer) for that, Instead, AICodeBot is built to work with existing code bases and help you improve them at the git-commit level. It's designed to multiply the effectiveness of capable engineers.
20
20
21
21
## Current features - how you can use it
22
22
@@ -75,14 +75,14 @@ Pro tip: You can also set the `OPENAI_API_KEY` environment variable to your API
75
75
-[ ]**Performance Optimization Suggestions**: Suggests potential performance optimizations for code.
76
76
-[ ]**Test Generation**: Generates unit tests for code, improve test coverage.
77
77
-[ ]**Integration with CI/CD pipelines**: Integrates with CI/CD pipelines to automate tasks like code review, testing, and deployment (via GitHub Actions). Eventually: Fix the build automatically when there are small errors.
78
-
-[ ]**Rubber Ducky Chat Bot**: Helps developers think through design issues by providing a conversational interface to discuss and solve problems, using data from the current repo.
78
+
-[ ]**Rubber Ducky Chat Bot**: Helps developers think through design issues by providing a conversational interface to discuss and solve problems, using data from the current repository.
79
79
-[X]**Linting/Formatting**: Checks code for linting errors and automatically fixes them where possible (via pre-commit)
80
80
-[ ]**Handle GitHub Issues**: Handles basic tasks that you assign to [@aicodebot](https://pypi.org/project/aicodebot/)
81
81
82
82
### User Interfaces
83
83
84
84
-[X]**Command-line, installable via pip**: aicodebot can be installed as a Python package using `pip install aicodebot`
85
-
-[ ]**Mention the @aicodebot GitHub user**: Mentioning the [@aicodebot](https://pypi.org/project/aicodebot/) GitHub user in a comment will trigger it to perform a task, review code, or pull in an appropriate gif.
85
+
-[ ]**Mention the @aicodebot GitHub user**: Mentioning the [@aicodebot](https://pypi.org/project/aicodebot/) GitHub user in a comment will trigger it to perform a task, review code, or pull in an appropriate GIF.
86
86
-[ ]**Callable as a GitHub action**: Can be called as a GitHub action to perform tasks on GitHub repositories.
87
87
-[ ]**Chat**: CLI chat interface that knows the context of your codebase and can answer questions about it. No more going back and forth between ChatGPT and command-line.
88
88
-[ ]**Slack Bot**: Interacts with aicodebot via slack, sends notifications, performs tasks, and provides real-time assistance to developers.
@@ -107,7 +107,7 @@ Pro tip: You can also set the `OPENAI_API_KEY` environment variable to your API
107
107
108
108
## Alignment ❤️ + 🤖
109
109
110
-
Technology itself is amoral, it just imbues the values of the engineers who create it. We believe that AI should be builtin a way that aligns with humanity, and we're building aicodebot to help us do just that. We're building from a heart-centered space, and contributing to the healthy intersection of AI and humanity.
110
+
Technology itself is amoral, it just imbues the values of the engineers who create it. We believe that AI should be built-in a way that aligns with humanity, and we're building aicodebot to help us do just that. We're building from a heart-centered space, and contributing to the healthy intersection of AI and humanity.
0 commit comments