/laguinho

CLI para publicar e recuperar dados no laguinho-api

Primary LanguagePythonMIT LicenseMIT

Laguinho chat on Discord

Interface de linha de comando (CLI) para publicar e recuperar dados no laguinho-api

Desenvolvimento

Este projeto é feito utilizando Python 3, você precisa tê-lo instalado na sua máquina.

Configurando a máquina

# instalando o pipenv
$ pip install --user pipenv

Configurando o projeto

# clonando o repositório
$ git clone https://github.com/OpenDevUFCG/laguinho.git
$ cd laguinho

# instalando as dependências
$ pipenv install

# executando o script de inicialização da versão de desenvolvimento 
$ pipenv run laguinho-dev [COMANDO]

Gerando um Github Token

github_token

Passo a passo

Para baixar os dados pelo comando get, é necessário fornecer um token de autenticação do Github, para gerá-lo basta seguir os passos descritos abaixo ou acesse este link e pule para o passo 5:

  1. Primeiramente, acesse a sua página de configurações do Github
  2. Selecione a aba Developer Settings
  3. Vá em Personal Access Token
  4. Clique em Generate new Token
  5. Adicione um nome e selecione a caixa de escolha user
  6. Clique em Generate token
  7. Copie o token gerado (obs: tenha certeza de ter copiado, uma vez que ele não será disponilizado novamente, apenas ao criar um novo token) e cole na CLI quando requisitado ou executando o comando configure.

Como Contribuir

Quer implementar alguma nova funcionalidade ou corrigir algum bug? Pode ir dando uma olhada nas issues abertas pra saber no que estamos trabalhando ou se preferir pode abrir sua própria caso queira corrigir ou adicionar algo novo!

Qualquer dúvida é só procurar a gente via discord ou pelas issues mesmo!

OBS: Esse ainda é um projeto em desenvolvimento, para acompanhar melhor, tudo começou com esta issue no laguinho-api, a partir dela você consegue chegar em toda a discussão sobre a CLI