{"id":29640777,"url":"https://github.com/sans-script/readme.ai","last_synced_at":"2025-07-21T21:05:12.615Z","repository":{"id":301062820,"uuid":"799278510","full_name":"sans-script/README.ai","owner":"sans-script","description":"O README.ai é um poderoso editor de README que incorpora o LLM (Large Language Model) Gemini da Google, permitindo a geração automática de README's a partir de prompts personalizados. Esse projeto foi concebido e desenvolvido por mim durante a Imersão AI da Alura + Google.","archived":false,"fork":false,"pushed_at":"2025-06-25T00:16:53.000Z","size":15,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-25T01:27:55.262Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sans-script.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-05-11T16:44:33.000Z","updated_at":"2025-06-25T00:16:56.000Z","dependencies_parsed_at":"2025-06-25T01:28:26.611Z","dependency_job_id":"a0475a39-80b0-4144-a711-d5fc131db90e","html_url":"https://github.com/sans-script/README.ai","commit_stats":null,"previous_names":["sans-script/readme.ai"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/sans-script/README.ai","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sans-script%2FREADME.ai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sans-script%2FREADME.ai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sans-script%2FREADME.ai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sans-script%2FREADME.ai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sans-script","download_url":"https://codeload.github.com/sans-script/README.ai/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sans-script%2FREADME.ai/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266379286,"owners_count":23920157,"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-07-21T11:47:31.412Z","response_time":64,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":[],"created_at":"2025-07-21T21:04:48.547Z","updated_at":"2025-07-21T21:05:12.607Z","avatar_url":"https://github.com/sans-script.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Editor de README.md Integrado com Inteligência Artificial\n\n### Introdução\n\nEste aplicativo Flet utiliza o modelo de linguagem avançada Gemini Pro da Google para criar README's com base em seus prompts.\n\nMas por que não usar o próprio site do Gemini para gerar o código Markdown? Muitos sites populares de IA já entregam respostas renderizadas em Markdown. No entanto, ao solicitar o código Markdown para elaborar um README, o modelo pode não oferecer exatamente o que você deseja. O código fornecido pode vir com a renderização já em Markdown, causando confusão. O modelo também pode falhar em fornecer o código completo, resultando em uma renderização incompleta.\n\n\n![Captura de tela 2024-05-11 110443](https://github.com/sans-script/README.ai/assets/84801905/16463ffd-9a98-401c-a33a-6c6a30c5d130)\n**Fig 1.** AI sendo AI.\n\nVocê pode obrigar o modelo a fornecer exatamente o código Markdown que você deseja. Boa sorte ao tentar fazer isso, pode levar um certo tempo. Mesmo copiando o texto já renderizado, ele não será idêntico ao texto Markdown original antes da renderização.\n\nSe você, assim como eu, tem preguiça de escrever um README.md, o README.ai chegou para resolver o seu problema e o do Gemini! O README.ai traz uma interface amigável semelhante à dos serviços da Google, graças à biblioteca Flet Python para construção de interfaces gráficas.\n\nO README.ai é uma solução rápida para quem quer gerar README's sem dor de cabeça, oferecendo a possibilidade de editar a resposta da IA em tempo real e adaptar conforme você desejar!\n\n### Funcionalidades:\n\n- **Interface amigável:** Uma caixa de texto simples para inserir seu prompt.\n- **Geração de README com IA:** O modelo Gemini Pro gera um README com base no seu prompt.\n- **Visualização em tempo real:** Exibe o README gerado em uma janela separada, com formatação Markdown.\n- **Edição do README:** Permite editar o README gerado em uma área de texto dedicada.\n- **Atualização dinâmica:** As alterações na área de texto editável são refletidas na visualização do README em tempo real.\n\n![Captura de tela 2024-05-11 113613](https://github.com/sans-script/README.ai/assets/84801905/d18af2b7-e0be-420f-879e-5a67f01c2833)\n**Fig 2.** Interface do editor\n\n### Como usar:\n\n1. **Insira o prompt:** Digite o que você deseja que o README.ai inclua na caixa de texto \"Escreva um README sobre...\".\n2. **Gere o README:** Clique no botão \"+\" para enviar o prompt ao modelo Gemini Pro.\n3. **Visualize e edite:** O README gerado será exibido na janela de visualização. Você pode editar o README na área de texto ao lado. \n4. **Aproveite seu novo README!**\n\n\n![Apresentação2](https://github.com/sans-script/README.ai/assets/84801905/e37dda9d-3a5a-40dc-8776-8a6eb29d3eda)\n**Fig 3.** As respostas brotam na tela do editor como se fosse mágica ✨ \n\n### Dependências:\n\n- `flet`: Para construir a interface do usuário. Visite [Flet for Python Docs](https://pypi.org/project/flet/) para mais informações.\n- `google.generativeai`: Para acessar o modelo Gemini Pro.\n- `dotenv e os`: Para gerenciar chaves de API\n\n### Configuração:\n\n1. **Instale as dependências:** `pip install flet python-dotenv google.generativeai` \n2. **Obtenha uma chave de API da Google:** Acesse [https://ai.google.dev/](https://ai.google.dev/) e siga as instruções para criar uma chave de API para o Google Generative AI.\n3. **Insira sua chave de API:** Crie um arquivo .env na raiz do seu diretório seguindo o .env.example\n\n### Executando o aplicativo:\n\n1. Basta executar o arquivo `main.py`\n2. A linha `ft.app(main, view=ft.WEB_BROWSER)` faz com que a visualização seja no navegador e não em janela como se fosse um programa. Por padrão, ao executar o `main.py`, você terá uma visualização em janela como se fosse um programa. Se quiser visualizar no navegador, basta adicionar o parâmetro`view=ft.WEB_BROWSER` em `ft.app(main)`\n\n```python\nft.app(main, view=ft.WEB_BROWSER) # No navegador\nft.app(main) # Em janela como se fosse um programa\n```\n\n\n### Notas:\n- Esta versão ainda está sujeita  à melhorias na interface e funcionalidades.\n- Este código usa o modelo `gemini-1.5-pro-latest`. Você pode explorar outros modelos disponíveis na documentação da Google Generative AI.\n- O estilo e o conteúdo do README gerado dependerão do seu prompt.\n- Certifique-se de ter uma conexão com a internet para usar o modelo Gemini Pro.\n- Divirta-se gerando READMEs incríveis! \n\n\n#\n\n✨ Made with ❤️ by README.ai\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsans-script%2Freadme.ai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsans-script%2Freadme.ai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsans-script%2Freadme.ai/lists"}