Skip to content

Jacinto-robate/tcc-assistant

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Assistente de Escrita de TCC

Um agente interativo que ajuda você a escrever seu TCC capítulo por capítulo, usando IA para pesquisar, gerar e melhorar textos seguindo as normas APA.

Funcionalidades

  • Escrita por capítulo: Trabalhe um capítulo por vez, do início ao fim
  • Pesquisa automática: O agente pesquisa na internet informações relevantes
  • TCCs de exemplo: Use PDFs de TCCs similares como referência de estilo
  • Formatação APA: Citações e referências formatadas automaticamente
  • Chat interativo: Converse com o agente para ajustes e dúvidas
  • Gerenciador de referências: Adicione e formate suas referências

Requisitos

  • Python 3.10 ou superior
  • Chave da API OpenAI

Instalação

  1. Clone ou baixe este projeto

  2. Instale as dependências:

pip install -r requirements.txt
  1. Configure sua chave da API OpenAI:
    • Copie o arquivo .env.example para .env
    • Edite o arquivo .env e adicione sua chave:
    OPENAI_API_KEY=sk-sua-chave-aqui
    

Como Usar

  1. Execute a aplicação:
streamlit run app.py
  1. O navegador abrirá automaticamente em http://localhost:8501

  2. Na tela de configuração:

    • Insira sua chave da API (se não configurou no .env)
    • Digite o tema do seu TCC
    • Faça upload de PDFs de TCCs de exemplo
    • Defina a estrutura (capítulos) do seu TCC
  3. Clique em "Começar a Escrever"

  4. Para cada capítulo:

    • Use a aba "Pesquisar" para buscar informações na internet
    • Use a aba "Escrever" para gerar o conteúdo
    • Use a aba "Chat" para pedir ajustes específicos
    • Use a aba "Referências" para gerenciar citações
    • Quando aprovar o texto, copie para o Word

Estrutura do Projeto

tcc-assistant/
├── app.py                 # Aplicação principal
├── requirements.txt       # Dependências
├── .env                   # Configuração (sua chave API)
├── .env.example           # Exemplo de configuração
├── modules/
│   ├── pdf_processor.py   # Processamento de PDFs
│   ├── web_researcher.py  # Pesquisa na internet
│   ├── tcc_agent.py       # Integração com OpenAI
│   └── apa_formatter.py   # Formatação APA
├── prompts/
│   └── system_prompts.py  # Prompts do sistema
└── data/
    └── exemplos/          # Pasta para PDFs de exemplo

Custos

A aplicação usa a API da OpenAI, que é paga por uso:

  • GPT-4o: ~$0.005 por 1K tokens de entrada, ~$0.015 por 1K tokens de saída
  • Estimativa: R$0.10 a R$0.50 por capítulo gerado

Dicas de Uso

  1. TCCs de exemplo: Quanto mais exemplos relevantes você fornecer, melhor o agente entenderá o estilo esperado

  2. Pesquise antes de gerar: Use a aba de pesquisa para coletar informações antes de gerar cada capítulo

  3. Seja específico nas instruções: Quanto mais detalhes você der nas instruções, melhor será o resultado

  4. Use o chat para ajustes: Depois de gerar, use o chat para pedir melhorias específicas

  5. Revise sempre: O texto gerado é um ponto de partida - revise e adapte conforme necessário

Normas APA 7ª Edição (Resumo)

Citações no texto

  • Um autor: (Silva, 2023)
  • Dois autores: (Silva & Santos, 2023)
  • Três ou mais: (Silva et al., 2023)
  • Citação direta: (Silva, 2023, p. 45)

Referências

  • Livro: Sobrenome, N. (Ano). Título. Editora.
  • Artigo: Sobrenome, N. (Ano). Título. Revista, v(n), pp-pp.
  • Site: Autor. (Ano). Título. URL

Suporte

Se encontrar problemas:

  1. Verifique se a chave da API está correta
  2. Verifique se tem créditos na sua conta OpenAI
  3. Verifique se os PDFs estão em formato legível (não escaneados como imagem)

About

Assistente de TCC com IA - Aplicação Streamlit + OpenAI GPT para auxiliar na escrita de TCC capítulo por capítulo

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages