README.md 1.26 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
# Tools

## Sobre

O objetivo desse repositório é armazenar ferramentas/*scripts* que tenham sido
desenvolvidos para o SIMMC(TIC) para auxiliar em alguma tarefa e/ou para
a realização de alguma tarefa temporária.

Para evitar que o conhecimento seja perdido e/ou que uma tarefa temporária
seja necessária novamente, as ferramenta/*scripts* utilizado são armazenados
nesse repositório.

Além disso existe a possibilidade de funcionalidades temporárias poderem
ser adicionadas permanentemente no portal e se esse conhecimento já
estiver armazenado nesse repositório já será meio caminho andado.

## Organização

* **scripts**: Diretório que contém *scripts* utilizados para alguma tarefa
    * query_reports: Transforma *templates* em queries validas e as executa.
    De preferencia essas consultas devem ser escritas para gerar um arquivo
    csv na saída padrão, mas nada impede que a consulta seja diferente.
    * config.sh: Arquivo não versionado, mas utilizado como arquivo de
    configuração para outros *scripts* em bash.
    * config.sh.example: Arquivo que deve ser usando de exemplo para
    criar o config.sh. NUNCA deve possuir informação sensível, apenas exemplos
* queries: Diretório qu contém consultas sql para os mais diferentes propósitos