https://github.com/a3data/templates-cli
https://github.com/a3data/templates-cli
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/a3data/templates-cli
- Owner: A3Data
- Created: 2025-05-27T14:04:38.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-29T21:19:10.000Z (9 months ago)
- Last Synced: 2025-09-29T23:33:17.241Z (9 months ago)
- Language: Python
- Size: 341 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CLI para Geração de Templates
Este projeto é uma ferramenta de linha de comando (CLI) para geração de templates, projetada para facilitar a criação de estruturas de projetos reutilizáveis. A CLI suporta dois tipos principais de templates: **Cookiecutter** e **Nix**, permitindo flexibilidade e personalização para diferentes cenários.
## Instalação
Para instalar a CLI, execute o seguinte comando:
```bash
pip install git+https://github.com/A3Data/templates-cli.git
```
Também é possível executar a CLI diretamente utilizando
```bash
pipx run --spec git+https://github.com/A3Data/templates-cli a3t
```
## Autenticação no GitHub
Para acessar repositórios privados de templates, é necessário autenticar-se no GitHub. Recomenda-se utilizar o [GitHub CLI (`gh`)](https://cli.github.com/):
No Ubuntu vc pode instalar pelo apt
```bash
sudo apt install gh
```
```bash
gh auth login
```
Siga as instruções para autenticar sua conta. Após isso, a CLI poderá acessar os repositórios necessários.
## Templates Disponíveis
Abaixo estão os templates atualmente suportados pela CLI, conforme configurado no arquivo templates.yaml:
1. batch - Batch processing template
2. lambda - AWS Lambda template
3. buora-oficial - Buora Oficial Templates
4. buora_infra - Buora Oficial Infra
5. ubq-data-infra - Ubique Data Infra
6. ubq-data-image - Ubique Data Image
7. ubq-data-pipeline - Ubique Data Pipeline
## Como Usar
Após instalar a CLI, você pode executar o comando principal para iniciar a ferramenta:
```bash
a3t
```
Siga as instruções interativas para selecionar um template e configurar seu projeto.
Também é necessario ter acesso aos repositorios dos templates para poder gerar eles usando a cli, caso vc não tenha acesso entre em contato com a equipe de soluções e inovação da A3 Data
## Outra documentação
1. [Criando Templates](./docs/CREATING_TEMPLATES.md)
2. [Desenvolvimento e Contribuição para a cli](./docs/DEVELOPMENT.md)