Skip to content

Commit 71e11e3

Browse files
update
1 parent 76e0ad9 commit 71e11e3

File tree

3 files changed

+80
-3
lines changed

3 files changed

+80
-3
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Bevan Hunt
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# NemoAgent
2+
NemoAgent is an AI Agent for Python codegen using the Mistral-Nemo Ollama framework. It creates project structures, writes code, writes tests, runs tests, and performs development tasks based on natural language prompts.
3+
4+
## Features
5+
* Runs completely local
6+
* Generate Python project structures automatically
7+
* Write Python code based on task descriptions
8+
* Execute development tasks using AI-generated commands
9+
* Utilize the Mistral-Nemo language model for intelligent code generation and testing
10+
* Implement best practices in Python development automatically
11+
12+
## Installation
13+
You can install NemoAgent using pip:
14+
15+
`pip install nemo-agent`
16+
17+
## Usage
18+
After installation, you can use NemoAgent from the command line:
19+
20+
`nemo-agent "Your task description here"`
21+
If you run nemo-agent without any arguments, it will prompt you to enter a task.
22+
23+
## Examples
24+
Create a simple calculator:
25+
26+
`nemo-agent "Create a simple calculator with add, subtract, multiply, and divide functions with tests"`
27+
28+
Generate a web scraper:
29+
30+
`nemo-agent "Build a web scraper to extract headlines from a news website with tests"`
31+
32+
Develop a basic API:
33+
34+
`nemo-agent "Create a Flask API with endpoints for user registration and login with tests"`
35+
36+
## How It Works
37+
38+
NemoAgent uses the Mistral-Nemo language model to interpret your task description.
39+
It generates a project structure and necessary files based on the task.
40+
The AI writes Python code to implement the requested functionality.
41+
NemoAgent can execute various development tasks like creating virtual environments, installing dependencies, and running tests.
42+
43+
## Requirements
44+
* Python 3.12.4 or higher
45+
* Ollama running mistral-nemo
46+
* Linux
47+
* Minimum of an RTX 4070
48+
49+
## Contributing
50+
Contributions to NemoAgent are welcome! Please feel free to submit a Pull Request.
51+
52+
## License
53+
This project is licensed under the MIT License - see the LICENSE file for details.
54+
55+
## Disclaimer
56+
NemoAgent generates code using AI. While it strives for accuracy and best practices, the generated code should be reviewed and tested before use in production environments.

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[tool.poetry]
22
name = "nemo-agent"
33
version = "0.0.1"
4-
description = "A tool for running ColabFold batch processing on RunPod"
5-
authors = ["Bevan Hunt"]
4+
description = "An AI Agent for python code gen using the Mistral-Nemo Ollama framework."
5+
authors = ["Bevan Hunt <[email protected]>"]
66
packages = [{include = "nemo_agent"}]
77

88
[tool.poetry.dependencies]
@@ -15,4 +15,4 @@ requires = ["poetry-core>=1.0.0"]
1515
build-backend = "poetry.core.masonry.api"
1616

1717
[tool.poetry.scripts]
18-
agent = "nemo_agent.main:cli"
18+
nemo-agent = "nemo_agent.main:cli"

0 commit comments

Comments
 (0)