{"id":32719095,"url":"https://github.com/8126lucas/readme-translator-agent","last_synced_at":"2025-11-02T18:03:19.802Z","repository":{"id":313545141,"uuid":"1050569632","full_name":"8126Lucas/README-translator-agent","owner":"8126Lucas","description":"🤖 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","archived":false,"fork":false,"pushed_at":"2025-09-06T18:38:36.000Z","size":276,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-06T20:35:23.081Z","etag":null,"topics":["ai-agents","command-line","command-line-tool","english-language","gemini-api","gemini-flash","portuguese","python","python-3","readme","readme-translation","translation","uv"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/8126Lucas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-04T16:05:22.000Z","updated_at":"2025-09-06T18:38:39.000Z","dependencies_parsed_at":"2025-09-06T20:35:24.763Z","dependency_job_id":"7497ad6f-7238-451f-85f5-0254498e2a8e","html_url":"https://github.com/8126Lucas/README-translator-agent","commit_stats":null,"previous_names":["8126lucas/readme-translator-agent"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/8126Lucas/README-translator-agent","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/8126Lucas%2FREADME-translator-agent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/8126Lucas%2FREADME-translator-agent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/8126Lucas%2FREADME-translator-agent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/8126Lucas%2FREADME-translator-agent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/8126Lucas","download_url":"https://codeload.github.com/8126Lucas/README-translator-agent/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/8126Lucas%2FREADME-translator-agent/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":282332561,"owners_count":26652047,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-11-02T02:00:06.609Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai-agents","command-line","command-line-tool","english-language","gemini-api","gemini-flash","portuguese","python","python-3","readme","readme-translation","translation","uv"],"created_at":"2025-11-02T18:02:31.189Z","updated_at":"2025-11-02T18:03:19.796Z","avatar_url":"https://github.com/8126Lucas.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rta (README Translator Agent) 🤖\n\n\u003cdiv align=\"center\"\u003e\n\u003ca href=\"README.pt.md\"\u003eLeia em Português\u003c/a\u003e | \u003ca href=\"#\"\u003eRead in English\u003c/a\u003e\n\u003c/div\u003e\n\n![GitHub License](https://img.shields.io/github/license/8126Lucas/README-translator-agent)\n![GitHub issues](https://img.shields.io/github/issues/8126Lucas/README-translator-agent)\n![GitHub stars](https://img.shields.io/github/stars/8126Lucas/README-translator-agent)\n![Python](https://img.shields.io/badge/python-v3.11-blue)\n![Platform](https://img.shields.io/badge/platform-windows%20%7C%20macos%20%7C%20linux-lightgrey)\n\nAn **AI agent** as a command-line tool to translate READMEs from Portuguese to English.\n\n## 🤔 Why did I create this?\nAs 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.\n\n## 📸 Screenshots\n|   README.pt.md   | Terminal | README.md |\n|----------------|---------------------|---------------------|\n| ![pt](screenshots/pt.png) | ![terminal](screenshots/terminal.png) | ![en](screenshots/en.png) |\n\n## 📱 How It Works\n1. Write in the `README.pt.md` file\n2. Run the command `rta README.pt.md`\n3. The `README.md` file is created/modified\n\n## 😎 When to use `rta`?\n- University projects you want to share internationally\n- Open-source code documentation\n- Any project where you need documentation in two languages\n\n## 📝 Example\n**Before (README.pt.md):**\n`## 🔧 Tecnologias Utilizadas`\n\n**After (README.md):**\n`## 🔧 Technologies Used`\n\n## 🔧 Technologies Used\n- **Python 3.13**: Python version used\n- **Gemini 2.0 Flash**: AI model for text processing\n- **Typer**: Python library to create command-line interfaces\n- **UV**: Python package manager\n\n## ⚙️ Install the Application\n1. Clone the repository:\n```bash\ngit clone https://github.com/8126Lucas/README-translator-agent.git\n```\n2. Check if UV is installed:\n```bash\nuv --version\n\n# If not installed\nwget -qO- https://astral.sh/uv/install.sh | sh              # macOS and Linux\npowershell -c \"irm https://astral.sh/uv/install.ps1 | more\"    # Windows (Powershell)\npip install uv                                                 # Alternative (PyPI)\n```\n3. Create the virtual environment:\n```bash\nuv venv\n```\n4. Install the dependencies:\n```bash\nuv pip install -r pyproject.toml\n\n# Or\nuv pip compile pyproject.toml -o requirements.txt\npip install -r requirements.txt\n```\n5. Create an API key from `Gemini 2.0 Flash` [here](https://aistudio.google.com/apikey)\n6. Create a `.env` file with the API key:\n```bash\nGEMINI_API_KEY=...\n```\n7. Navigate to the `README-translator-agent` directory\n8. Install the agent:\n```bash\npip install -e .\n```\n\n## 📁 Project Structure\n```bash\nREADME-translator-agent/\n├── rta/\n│   ├── __init__.py\n│   └── main.py  \n├── .env \n├── pyproject.toml\n├── README.pt.md\n└── README.md\n```\n\n## ⚠️ Known Issues\n- The agent only translates from Portuguese to English\n- Sometimes, the agent doesn't fully comply with the prompt\n\n## 🛠️ Troubleshooting\n**Q: Can I use another model instead of Gemini 2.0 Flash?**\n**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.\n\n## 🤝 How to Contribute\n1. Fork the project\n2. Create a branch for your feature (`git checkout -b feature/new-feature`)\n3. Commit your changes (`git commit -am 'Add new feature'`)\n4. Push to the branch (`git push origin feature/new-feature`)\n5. Open a Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F8126lucas%2Freadme-translator-agent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F8126lucas%2Freadme-translator-agent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F8126lucas%2Freadme-translator-agent/lists"}