https://github.com/apneduniya/composio-code-analyser
https://github.com/apneduniya/composio-code-analyser
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/apneduniya/composio-code-analyser
- Owner: apneduniya
- License: mit
- Created: 2024-08-19T18:03:56.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-08-19T18:20:39.000Z (9 months ago)
- Last Synced: 2025-01-04T19:23:42.283Z (5 months ago)
- Language: Python
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Code Analyser
Meet our new AI made using [**composio**](https://www.composio.dev/) & [**crew AI**](https://docs.crewai.com/)! 🎉 This AI helps you to analysis your code present in any directory of your desktop.
Table of Contents
-
Getting Started
- Project Structure
- Contributing
- License
## 🫳 Prerequisites
You should have
- Python 3.8 or higher
- OPENAI API KEY
- [COMPOSIO API KEY / COMPOSIO CLI](https://docs.composio.dev/patterns/howtos/get_api_key)
## 👣 Steps to Run
**Navigate to the Project Directory:**
Change to the directory where the `setup.sh`, `main.py`, `requirements.txt`, and `README.md` files are located. For example:
```shell
cd path/to/project/directory
```
### 1. Run the Setup File
Make the setup.sh Script Executable (if necessary):
On Linux or macOS, you might need to make the setup.sh script executable:
```shell
chmod +x setup.sh
```
Execute the setup.sh script to set up the environment, install dependencies, login to composio and
add necessary tools:
```shell
./setup.sh
```
Now, Fill in the `.env` file with your secrets.
### 2. Run the python script
```shell
python3 main.py
```
## 🏛️ Project structure
```bash
├── .env.example
├── .gitignore
├── LICENSE
├── main.py
├── README.md
├── requirements.txt
└── setup.sh
```
## 🤗 Contributing
1. Fork the repository.
2. Create a new branch: `git checkout -b feature-name`.
3. Make your changes.
4. Push your branch: `git push origin feature-name`.
5. Create a pull request.
## 🧾 License
This project is licensed under the [MIT License](LICENSE).