Pular para conteúdo

Feministech Bot ✨

❓ Este é nosso bot disponível em todos os chats dos canais de pessoas streamers da comunidade Feministech, foi feito em Python, utilizando o gerenciador de ambientes Poetry, a biblioteca TwitchIO, as ferramentas de qualidade de código blue e isort, com automações utilizando taskipy, e totalmente documentado com Mkdocs.

📋 Requisitos

🤖 Produção

🧰 Desenvolvimento

📚 Documentação

🔎 Como utilizar

Para utilizar ou trabalhar tanto no bot, quanto na documentação é necessário rodar o comando abaixo no seu terminal, dentro da pasta do projeto na sua máquina:

poetry install

🤖 Bot

Para utilizar o bot, basta seguir os próximos passos:

  • Configure o arquivo config.ini.

📚 Para mais informações sobre esse arquivo, acesse a nossa documentação clicando aqui.

  • Execute o bot:

poetry run bot 💜 | Conectado a Twitch com sucesso!

⚠️ É necessário desligar o bot com as teclas de atalho CTRL + C e rodá-lo novamente com o comando acima, a cada alteração feita em seu código.

📚 Para mais informações de como configurar o seu ambiente Python com Poetry, acesse a nossa documentação clicando aqui.

📚 Documentação

Para trabalhar na documentação, basta editar os arquivos markdown (.md) dentro da pasta docs.

Caso precise adicionar imagens ou outros conteúdos de mídia na documentação, por padrão, deixe-os na pasta docs/assets.

Ou para alterações e melhorias no estilo, basta editar o arquivo extra.css, dentro da pasta docs/stylesheets.

Para visualizar as alterações feitas na documentação na sua máquina, basta rodar o comando e acessar pelo endereço informado na última linha (nesse exemplo, seria o http://127.0.0.1:8000/):

poetry run task docs INFO - Building documentation... INFO - Cleaning site directory INFO - Documentation built in 0.14 seconds INFO - [10:02:13] Watching paths for changes: 'docs', 'mkdocs.yml' INFO - [10:02:13] Serving on http://127.0.0.1:8000/

📋 Issues

Fique à vontade para abrir uma issue caso encontre algum bug ou tenha alguma sugestão, assim podemos discutir o melhor caminho para melhorá-la ou corrigi-lá.

👋 Contribuição

Você será sempre bem-vinde a contribuir com este projeto, pedimos apenas que preze pela qualidade de código, seguindo a estrutura e organização planejada nele.

Ao finalizar o trabalho, não deixe de rodar as nossas ferramentas de qualidade de código, com o comando abaixo:

poetry run task lint

Finalizados os trabalhos, basta criar sua pull request e aguardar a revisão.

💡 Aproveite e confira nas nossas issues, se existe alguma prioridade ou sugestão de contribuição.

📜 Licença

Este projeto é feito sobre a licença GNU, para mais informações sobre a sua possível utilização, modificação e compartilhamento, clique aqui.

Feito com ❤️ pela comunidade Feministech.