https://github.com/8126lucas/readme-translator-agent
🤖 An AI Agent (using the gemini-2.0-flash-001 model) which translates and creates a README (from portuguese to english, for now). Written in Python
https://github.com/8126lucas/readme-translator-agent
ai-agents command-line command-line-tool english-language gemini-api gemini-flash portuguese python python-3 readme readme-translation translation uv
Last synced: 7 months ago
JSON representation
🤖 An AI Agent (using the gemini-2.0-flash-001 model) which translates and creates a README (from portuguese to english, for now). Written in Python
- Host: GitHub
- URL: https://github.com/8126lucas/readme-translator-agent
- Owner: 8126Lucas
- License: mit
- Created: 2025-09-04T16:05:22.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-09-06T18:38:36.000Z (9 months ago)
- Last Synced: 2025-09-06T20:35:23.081Z (9 months ago)
- Topics: ai-agents, command-line, command-line-tool, english-language, gemini-api, gemini-flash, portuguese, python, python-3, readme, readme-translation, translation, uv
- Language: Python
- Homepage:
- Size: 270 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rta (README Translator Agent) 🤖
An **AI agent** as a command-line tool to translate READMEs from Portuguese to English.
## 🤔 Why did I create this?
As a university student, I have more than one project to do almost every semester. These projects can, and should, be used as an expansion of my portfolio. Since not everyone in the world speaks my native language, I decided to start writing the documentation in English as well, an international language. However, writing documentation twice is, for me, a waste of time. For a few days, I was thinking about a way to automate the process until I came across the concept of *agents*. And that's how **rta** came about.
## 📸 Screenshots
| README.pt.md | Terminal | README.md |
|----------------|---------------------|---------------------|
|  |  |  |
## 📱 How It Works
1. Write in the `README.pt.md` file
2. Run the command `rta README.pt.md`
3. The `README.md` file is created/modified
## 😎 When to use `rta`?
- University projects you want to share internationally
- Open-source code documentation
- Any project where you need documentation in two languages
## 📝 Example
**Before (README.pt.md):**
`## 🔧 Tecnologias Utilizadas`
**After (README.md):**
`## 🔧 Technologies Used`
## 🔧 Technologies Used
- **Python 3.13**: Python version used
- **Gemini 2.0 Flash**: AI model for text processing
- **Typer**: Python library to create command-line interfaces
- **UV**: Python package manager
## ⚙️ Install the Application
1. Clone the repository:
```bash
git clone https://github.com/8126Lucas/README-translator-agent.git
```
2. Check if UV is installed:
```bash
uv --version
# If not installed
wget -qO- https://astral.sh/uv/install.sh | sh # macOS and Linux
powershell -c "irm https://astral.sh/uv/install.ps1 | more" # Windows (Powershell)
pip install uv # Alternative (PyPI)
```
3. Create the virtual environment:
```bash
uv venv
```
4. Install the dependencies:
```bash
uv pip install -r pyproject.toml
# Or
uv pip compile pyproject.toml -o requirements.txt
pip install -r requirements.txt
```
5. Create an API key from `Gemini 2.0 Flash` [here](https://aistudio.google.com/apikey)
6. Create a `.env` file with the API key:
```bash
GEMINI_API_KEY=...
```
7. Navigate to the `README-translator-agent` directory
8. Install the agent:
```bash
pip install -e .
```
## 📁 Project Structure
```bash
README-translator-agent/
├── rta/
│ ├── __init__.py
│ └── main.py
├── .env
├── pyproject.toml
├── README.pt.md
└── README.md
```
## ⚠️ Known Issues
- The agent only translates from Portuguese to English
- Sometimes, the agent doesn't fully comply with the prompt
## 🛠️ Troubleshooting
**Q: Can I use another model instead of Gemini 2.0 Flash?**
**A:** Yes. If it's a Gemini model, you just need to change the model name (`model='gemini-2.0-flash-001'`). If it's another model, other modifications will be necessary, as the library (`from google import genai`) will not be useful.
## 🤝 How to Contribute
1. Fork the project
2. Create a branch for your feature (`git checkout -b feature/new-feature`)
3. Commit your changes (`git commit -am 'Add new feature'`)
4. Push to the branch (`git push origin feature/new-feature`)
5. Open a Pull Request