PkgFoundry
Catalog PyPI
Back to packageRELEASE DETAILS

1.2.10

PyPI

abin-sim

ABIN é um CLI para interagir com a API do Vault e auxiliar os Desenvolvedores nos projetos da SIMTech

Published29 Jan 2024
Direct dependencies5
Transitive dependenciesNot calculated

README

Version 1.2.10 documentation

ABIN

CI PyPI version

Instalação

Utilize o pipx para instalar o abin no seu computador.

sudo apt install pipx
pipx install abin_sim

A versão da aplicação no README será atualizada sempre que um novo build rodar.

Se você estiver rodando no PopOS precisa criar um link simbólico para a aplicação ou adicionar $HOME/.local/bin no path do SO

sudo ln -s $HOME/.local/bin/abin /usr/local/bin/abin

Configuração

Após realizar a instalação do App, será necessário iniciar o arquivo de configuração Para isso execute a instrução abaixo:

abin --configure

A instrução acima criará um arquivo chamado 'settings.toml' em $HOME/abin/ Com o arquivo em mãos, altere o valor de vault_token para o seu token, o valor deverá focar entre " "

vault_token -> Seu token de autenticação no Vault

Para ter acesso seu token basta autenticar no Web UI do Vault. Acesse no seu navegador o endereço https://aspirina.simtech.solutions PS: O acesso devera ser solicitado ao time de SRE da SIMTech

Na tela de login:

  • Mude Method para Username
  • Entre com o seu usuário em Username
  • Entre com a sua senha em Password
  • Clique em More Options
  • Em Mount Path digite simtech
  • Clique em Sign in

Após o login clique no boneco localizao no canto superior direito e, após, clique em Copy Token

Importante: O Token é válido por 30 dias, portanto lembre de renová-lo.

Funções

DESCRITIVO

Uso: abin

Retorna uma breve explicação sobre a funcionalidade do CLI.
Traz exemplos de uso e link para projeto no GitHub

VERSION

Uso: abin --version

Retorna a versão atualmente instalada no SO.
Para atualizá-la:

pipx upgrade abin_sim

CONFIGURE

Uso: abin --configure

Gera o arquivo de configuração da aplicação.

LIST

Uso: abin list

Retorna a árvore de Secrets cadastradas no Path obedecendo a referência abaixp
╭─ Referência ──────────────────╮
│                               │ 
│ Vault Environment:            │
│     ├── (env)-(proj)          │
│     │    ├── (api)            │
│                               │
╰─ Referência ──────────────────╯

GET

Uso: abin get [OPTIONS]                                                                                                                            
                                                                                                                                                  
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *  --app                  TEXT  Nome da aplicação que deseja recuperar os secrets. [default: None] [required]                                        │
│ *  --env                  TEXT  Ambiente da aplicação que deseja recuperar (Envs possíveis: dev, qa, main). [default: None] [required]               │
│ *  --proj                 TEXT  Projeto que deseja conectar para recuperar os secrets (Projs possíveis: sim, charrua) [default: None] [required]     │
│    --file    --no-file          Cria um arquivo para cada path cadastrada no secrets. [default: file]                                                │
│    --help                       Show this message and exit.                                                                                          │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Examplo:
* Imprime os dados no StdOut (Tela)
    abin get --app api-auth --env dev --proj sim --no-file
* Imprime os dados em arquivo (Com base no arquivo $HOME/abin/settings.toml)
    abin get --app api-auth --env dev --proj sim

UPDATE

Uso: abin update [OPTIONS] 
                                           
╭─ Options─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *  --app         TEXT  Nome da aplicação que deseja recuperar os secrets. [default: None]  [required]                                        │
│ *  --env         TEXT  Ambiente da aplicação que deseja recuperar (Envs possíveis: dev, qa, main). [default: None] [required]                │
│ *  --proj        TEXT  Projeto que deseja conectar para recuperar os secrets (Projs possíveis: sim, charrua) [default: None] [required]      │
│    --secret      TEXT  Secret que será atualizada no Vault (Ex.: env, gcp.json, config.yaml ...) [default: env]                              │
│ *  --file        TEXT  Arquivo com variárias de ambiente [default: None] [required]                                                          │
│    --help              Show this message and exit.                                                                                           │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Eexamplo:
    abin update --app api-auth --env dev --proj sim --file .env  (para atualizar outro secret use --secret NOME)

COMPARE

Uso: abin compare [OPTIONS]

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *  --app                  TEXT  Nome da aplicação que deseja recuperar os secrets. [default: None] [required]                                            │
│ *  --env                  TEXT  Ambiente da aplicação que deseja recuperar (Envs possíveis: dev, qa, main). [default: None] [required]                   │
│ *  --proj                 TEXT  Projeto que deseja conectar para recuperar os secrets (Projs possíveis: sim, charrua) [default: None] [required]         │
│    --help                       Show this message and exit.                                                                                              │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Eexamplo:
    abin compare --app api-auth --env qa,dev --proj sim

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 5

Native requirements
5 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
requests
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10,<4.0",
  "evaluation": "NOT_EVALUATED"
}
requests (>=2.28.2,<3.0.0)runtime
typer
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10,<4.0",
  "evaluation": "NOT_EVALUATED"
}
typer (>=0.7.0,<0.8.0)runtime
rich
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10,<4.0",
  "evaluation": "NOT_EVALUATED"
}
rich (>=13.3.4,<14.0.0)runtime
pathlib3x
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10,<4.0",
  "evaluation": "NOT_EVALUATED"
}
pathlib3x (>=2.0.2.1,<3.0.0.0)runtime
dynaconf
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10,<4.0",
  "evaluation": "NOT_EVALUATED"
}
dynaconf (>=3.1.12,<4.0.0)runtime

Distribution files

2 collected
abin_sim-1.2.10-py3-none-any.whl

bdist_wheel · 9.97 KB · Python py3

Source file
abin_sim-1.2.10.tar.gz

sdist · 9.68 KB · Python source

Source file

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 17:26 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:86a0d06e6530fa3d0d64aeadd250db75bc10d02c3e80d48972533cb79c74450a

Other collected versions

View all collected versions →