TodoCLI


sdSS_SSSSSSbs
YSSS~S%SSSSSP
     S&S               __      ________    ____
     S&S    ____  ____/ /___  / ____/ /   /  _/
     S*S   / __ \/ __  / __ \/ /   / /    / /
     S*S  / /_/ / /_/ / /_/ / /___/ /____/ /
     S*S  \____/\____/\____/\____/_____/___/
     S*S
     SP
     Y

Uma simples todo list CLI feita utilizando as bibliotecas:

Textual

Rich

Índice

Início
Índice
Instalação
Como contribuir?
Como usar?
- Criando/Abrindo uma Todo.
- Comandos
  - Combinações de teclas
  - Manipulação de task
Configuração
- Alterando banner ASCII

Instalação

Para instalar o projeto siga as etapas a seguir:

Clone o repositório utilizando em seu terminal: git clone https://github.com/rodrigosj7/TodoCLI
Realize a instalação das bibliotecas/dependências necessárias. pip install -r requeriments.txt

Como contribuir?

Caso tenha ideias de melhorias ou adições, faça uma issue ou um pull request. Saiba mais como criar uma solicitação de pull.

Como usar?

Criando/Abrindo uma Todo.

Para abrir ou criar um todo(os todos sao arquivos json's):

python3 main.py --todo <nome do todo>.json

Entretanto se nenhum arquivo for encontrado, será criado uma todo vazia no diretório atual. Caso apenas execute o arquivo main.py sem passar os argumentos necessários, o arquivo home.py será executado. Assim exibindo a tela inicial, que nela contém suas configurações e uma ASCII Art.

Comandos

Combinações de teclas

ctrl+q: sair.
ctrl+o: abrir painel de informações (informações da todo).

Eles podem ser alterados para teclas de sua preferência...

Manipulação de task

add <tarefa> ou add :id: é utilizado para adicionar uma tarefa ao todo.
rm <tarefa> ou rm :id: remove tarefa existente.
check <tarefa> ou check :id: basicamente marca a tarefa como concluída.
uncheck <tarefa> ou uncheck :id: marca a tarefa como pendente novamente.

As tarefas possuem 2 estados, <pending>(pendente) e <completed>(completo/concluído)

Configurando

Após a execução do arquivo main.py é gerado um arquivo chamado config.json. Onde podemos definir algumas "Combinações de Teclas" e a cor primária da todo list.

parâmetro	argumentos	valor
keymapping	`exit` e `pannel_toggle`	Teclas(combinções de teclas) para executar `exit` e `pannel_toggle`
pallete	`primary`	`blue`, `red`, `green` e etc..

o arquivo config.json terá a seguinte estrutura por padrão.

{
  "keymapping": {
    "exit": "ctrl+q",
    "panel_toggle": "ctrl+o"
  },
  "pallete": {
    "primary": "blue"
  }
}

Alterando banner ASCII

Para colocar uma ascii art de sua preferência para a home, substitua ascii definida em ascii_banner.

⬆ Voltar ao top

Made with 💜 by Rodrigo Sennshi

orodrigojose/TodoCLI