docs(pt-br): Docs Translation to brazilian portugues. (#787)

dynaconf · Sep 2, 2022 · 4ef1614 · 4ef1614
1 parent 25806fc
commit 4ef1614
Show file tree

Hide file tree

Showing 2 changed files with 388 additions and 0 deletions.
diff --git a/docs/pt-br/docs/cli.md b/docs/pt-br/docs/cli.md
@@ -0,0 +1,243 @@
+
+
+## configurando instancias
+
+Todo comando (com exceção do init) requer uma Instância que pode ser passada usando o parâmetro `-i` ou por variável de ambiente com `export INSTANCE_FOR_DYNACONF`
+
+## O dynaconf CLI (Interface de Linha de Comando)
+
+O comando `$ dynaconf -i config.settings` do cli provê alguns comandos bem úteis
+
+> **IMPORTANTE** caso usem [Flask Extension](/flask/) a variável de ambiente `FLASK_APP` deve ser definda para usar o CLI, e caso usem [Django Extension](/django/) a variável `DJANGO_SETTINGS_MODULE` deve estar definida.
+
+### dynaconf --help
+
+```bash
+Uso: dynaconf [OPÇÕES] COMMAND [ARGS]...
+
+  Dynaconf - Command Line Interface
+
+  Documentation: https://dynaconf.com/
+
+Opções:
+  --version            Mostra a versão do dynaconf
+  --docs               Abre a documentação no navegador
+  --banner             Mostra um banner maneiro
+  -i, --instance TEXT  Define a instância customizada do LazySettings
+  --help               Mostra essa mensagem e sai.
+
+Commands:
+  get       Retorna o valor bruto de uma chave de configuração
+  init      Inicia um projeto dynaconf, por padrão cria um settings.toml ...
+  list      Lita todos os valores de configuração definidos pelo usuário se `--all` é passado ...
+  validate  Valida as configurações do Dynaconf baseado em regras definidas em...
+  write     Escreve dados para o recurso específico
+```
+
+### dynaconf init
+
+Use o comando init para facilmente iniciar a configuração de sua aplicaçãoto, tendo o dynaconf instalado vá para o diretório raiz de sua aplicação e execute:
+
+```
+$ dynaconf init -v key=value -v foo=bar -s token=1234
+```
+
+O comando acima criará no diretório corrente:
+
+`settings.toml`
+
+```ini
+KEY = "value"
+FOO = "bar"
+```
+
+also `.secrets.toml`
+
+```ini
+TOKEN = "1234"
+```
+
+Bem como incluirá no arquivo `.gitignore` para que seja ignorado o arquivo `.secrets.toml`, como descrito abaixo:
+
+```ini
+# Ignore dynaconf secret files
+.secrets.*
+```
+
+> Reomenda-se que para dados sensíveis em produção use[Vault Server](/secrets/)
+
+```
+Uso: dynaconf init [OPÇÕES]
+
+  Inicia um projeto dynaconf que por padrão cria um settings.toml e um
+  .secrets.toml para os ambientes [default|development|staging|testing|production|global].
+
+  O formato dos arquivo pode ser alterado passando --format=yaml|json|ini|py.
+
+  Esse comando deve ser executado no diretório raiz do projeto o pode-se passar 
+  --path=/myproject/root/folder.
+
+  O --env/-e está depreciado ( mantido por compatibilidade, mas deve evitar o uso) 
+
+Opções:
+  -f, --format [ini|toml|yaml|json|py|env]
+  -p, --path TEXT                 o padrão é o diretório corrente
+  -e, --env TEXT                  Define o ambiente de trabalho no arquivo `.env`
+  -v, --vars TEXT                 valores extras a serem gravados no arquivo de settings, ex.:
+                                  `dynaconf init -v NAME=foo -v X=2
+
+  -s, --secrets TEXT              valores sensíveis a serem escritos no arquivo .secrets 
+                                  ex.: `dynaconf init -s TOKEN=kdslmflds
+
+  --wg / --no-wg
+  -y
+  --django TEXT
+  --help                          Mostra essa mensagem e sai.
+```
+
+Observe que a opção `-i`/`--instance` não pode ser usada com `init`, pois `-i` deve apontar para uma instância existente das configurações.
+
+
+### Dynaconf get
+
+Pega o valor bruto para uma única chave
+
+```bash
+Uso: dynaconf get [OPÇÕES ] KEY
+
+  Retorna o valor bruto para a KEY na configuração
+
+Opções:
+  -d, --default TEXT  Valor padrão se a configuração não existir
+  -e, --env TEXT      Filtra o ambiente (env) para pegar os valores do ambiente especificado
+  -u, --unparse       Não analisa (unparse) os dados pela adição de marcadores como: @none, @int etc..
+  --help              Mostra essa mensagem e sai.
+```
+
+Exemplo:
+
+```bash
+export FOO=$(dynaconf get DATABASE_NAME -d 'default')
+```
+
+
+### dynaconf list
+
+Lista todos os parâmetros definidos e, opcionalmente, exporta para um arquivo JSON.
+
+```
+Uso: dynaconf list [OPÇÕES]
+
+  Lista todos os valores de configuração definidos pelo usuário e se `--all` for passado 
+  mostra, também, as variáveis internas do dynaconf.
+
+Opçẽos:
+  -e, --env TEXT     Filtra o ambiente (env) para pegar os valores
+  -k, --key TEXT     Filtra por uma única chave (key)
+  -m, --more         Pagina o resultado ao estilo mais|menos (more|less)
+  -l, --loader TEXT  um identificador de conversor (loader) para filtar ex.: toml|yaml
+  -a, --all          Mostra as configurações internas do dynaconf? 
+  -o, --output FILE  Filepath para gravar os valores listados num arquivo JSON
+  --output-flat      O arquivo de saída é plano (flat) (i.e., não inclui o nome ambiente [env])
+  --help             Mostra essa mensagem e sai.
+```
+
+#### Exportanto o ambiente atual como um arquivo
+
+```bash
+dynaconf list -o path/to/file.yaml
+```
+
+O comando acima exportará todos os itens mostrados por `dynaconf list` para o format desejado o qual é inferido pela extensão do arquivo em `-o`, formatos suportados são: `yaml, toml, ini, json, py` 
+
+Quando se usa `py` pode-se querer uma saída plana (flat) (sem estar aninhada internamente pelo nome do ambiente (env))
+
+```bash
+dynaconf list -o path/to/file.py --output-flat
+```
+
+### dynaconf write
+
+```
+Uso: dynaconf write [OPÇÕES] [ini|toml|yaml|json|py|redis|vault|env]
+
+  Escreve os dados dem uma fonte específica
+
+Opções:
+  -v, --vars TEXT     Par chave=valor que será escrito no settings ex.: 
+                      `dynaconf write toml -e NAME=foo -e X=2
+
+  -s, --secrets TEXT  Par chave=segredo que será escrito no .secrets ex:
+                      `dynaconf write toml -s TOKEN=kdslmflds -s X=2
+
+  -p, --path TEXT     Diretório/Arquivo no qual será escrito, sendo o padrão para diretório-atual/settings.{ext}
+  -e, --env TEXT      Ambiente para o qual o valor será registrado o padrão é o DEVELOPMENT, para arquivos de recursos
+                      externos como o Redis e o Vault será
+                      DYNACONF ou o valor configurado na variável $ENVVAR_PREFIX_FOR_DYNACONF
+
+  -y
+  --help              Mostra essa mensagem e sai.
+```
+
+### dynaconf validate
+
+> **Novo desde a versão 1.0.1**
+
+Iniciado na versão 1.0.1, é possível definir validadores no arquivo **TOML** chamado **dynaconf_validators.toml** colocado na mesma pasta do seu arquivo settings.
+
+`dynaconf_validators.toml` equivalente ao descrito acima
+
+```ini
+[default]
+
+version = {must_exist=true}
+name = {must_exist=true}
+password = {must_exist=false}
+
+  [default.age]
+  must_exist = true
+  lte = 30
+  gte = 10
+
+[production]
+project = {eq="hello_world"}
+```
+
+Para executar a validação use o comando abaixo:
+
+```
+$ dynaconf -i config.settings validate
+```
+
+A validação ocorrendo sem problemas retornará status 0 (sucesso) e, por isso, o comando pode ser usado na pipeline de CI/CD/Deploy.
+
+### dynaconf --version
+
+Retorna a versão do dynaconf instalada
+
+```
+$ dynaconf -i config.settings --version
+1.0.0
+```
+
+### dynaconf --docs
+
+Abre a documentação do Dynaconf no navegador padrão do sistema.
+
+
+### dynaconf --banner
+
+Imprime esse bonito baner feito em ascci no terminal :)
+
+```
+$ dynaconf -i config.settings --banner
+
+██████╗ ██╗   ██╗███╗   ██╗ █████╗  ██████╗ ██████╗ ███╗   ██╗███████╗
+██╔══██╗╚██╗ ██╔╝████╗  ██║██╔══██╗██╔════╝██╔═══██╗████╗  ██║██╔════╝
+██║  ██║ ╚████╔╝ ██╔██╗ ██║███████║██║     ██║   ██║██╔██╗ ██║█████╗
+██║  ██║  ╚██╔╝  ██║╚██╗██║██╔══██║██║     ██║   ██║██║╚██╗██║██╔══╝
+██████╔╝   ██║   ██║ ╚████║██║  ██║╚██████╗╚██████╔╝██║ ╚████║██║
+╚═════╝    ╚═╝   ╚═╝  ╚═══╝╚═╝  ╚═╝ ╚═════╝ ╚═════╝ ╚═╝  ╚═══╝╚═╝
+
+Learn more at: http://github.com/rochacbruno/dynaconf
+```
diff --git a/docs/pt-br/docs/index.md b/docs/pt-br/docs/index.md
@@ -0,0 +1,145 @@
+# Início Rápido com Dynaconf 
+
+<p style="align-content: center">
+  <a href="https://dynaconf.com"><img src="img/logo_400.svg?sanitize=true" alt="Dynaconf"></a>
+</p>
+<p style="align-content: center">
+    <em>Gereciamento de Configurações para Python.</em>
+</p>
+
+<p style="align-content: center"><a href="/LICENSE"><img alt="MIT License" src="https://img.shields.io/badge/license-MIT-007EC7.svg?style=flat-square"></a> <a href="https://pypi.python.org/pypi/dynaconf"><img alt="PyPI" src="https://img.shields.io/pypi/v/dynaconf.svg"></a><a href="https://github.com/rochacbruno/dynaconf/actions/workflows/main.yml"><img src="https://github.com/rochacbruno/dynaconf/actions/workflows/main.yml/badge.svg"></a><a href="https://codecov.io/gh/rochacbruno/dynaconf"><img alt="codecov" src="https://codecov.io/gh/rochacbruno/dynaconf/branch/master/graph/badge.svg"></a> <a href="https://www.codacy.com/gh/rochacbruno/dynaconf/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=rochacbruno/dynaconf&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/42d2f11ef0a446808b246c8c69603f6e"/></a> <img alt="GitHub Release Date" src="https://img.shields.io/github/release-date/rochacbruno/dynaconf.svg"> <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/rochacbruno/dynaconf.svg"> <a href="https://github.com/rochacbruno/dynaconf/discussions"><img alt="Discussions" src="https://img.shields.io/badge/discussions-forum-yellow.svg?logo=googlechat"></a> <a href="https://github.com/rochacbruno/learndynaconf"><img alt="Demo" src="https://img.shields.io/badge/demo-learn-blue.svg?logo=gnubash"></a></p>
+
+
+[![Foo](https://xscode.com/assets/promo-banner.svg)](https://xscode.com/rochacbruno/dynaconf)
+
+> **DICA** Você pode ver uma exmplo funcional aqui (em inglês): https://github.com/rochacbruno/learndynaconf
+
+## Recursos
+
+- Inspirado no **[12-factor application guide](https://12factor.net/pt_br/config)**
+- **Gerenciamento de configurações** (valores padrão, validação, análise (parsing), modelagem (templating))
+- Proteção de **informações sensíveis** (passwords/tokens)
+- Múltiplos **formatos de arquivos** `toml|yaml|json|ini|py` e, também, carregadores (loaders) personalizáveis.
+- Suporte total para **variáveis de ambiente** para substituir as configurações existentes (incluindo suporte a dotenv).
+- Sistema em camadas opcionais para **vários ambientes** `[padrão, desenvolvimento, teste, produção]` (também chamado multiplos perfis)
+- Suporte nativo para **Hashicorp Vault** e **Redis** para configurações e amarzenamento de segredos.
+- Extensões nativas para **Django**, **Flask** e **fastAPI** web framewors.
+- **CLI** para operações comuns tais como `init, list, write, validate, export`.
+
+## Instalação
+
+### Instalando via [pypi](https://pypi.org/project/dynaconf)
+
+```bash
+pip install dynaconf
+```
+### Initialize Dynaconf on your project
+
+???+ "Usando somente Python"
+
+    #### Usando somente Python
+
+    No diretório raiz de seu projeto execute o comando `dynaconf init`    
+
+    ```bash hl_lines="2"
+    cd path/to/your/project/
+    dynaconf init -f toml
+    ```
+    A saída do comando deverá ser:
+
+    ```plain
+
+    ⚙️  Configuring your Dynaconf environment
+    ------------------------------------------
+    🐍 The file `config.py` was generated.
+
+    🎛️  settings.toml created to hold your settings.
+
+    🔑 .secrets.toml created to hold your secrets.
+
+    🙈 the .secrets.* is also included in `.gitignore`
+    beware to not push your secrets to a public repo.
+
+    🎉 Dynaconf is configured! read more on https://dynaconf.com
+    ```
+
+    > ℹ️ Você pode escolher `toml|yaml|json|ini|py` em `dynaconf init -f <fileformat>`,  **toml** é o formato padrão e o mais **recomendado** para configurações.
+
+    O comando `init` do Dynaconf cria os seguintes arquivos
+
+    ```plain
+    .
+    ├── config.py       # No qual você importa seu objeto de configuração (obrigatório)
+    ├── .secrets.toml   # Arquivo com dados sensíveis como senhas e tokesn (opctional)
+    └── settings.toml   # Configurações da aplicação (opcional)
+    ```
+
+    === "your_program.py"
+        Em seu código você importa e usa o objeto **settings**, este é importado do arquivo **config.py**
+        ```python
+        from config import settings
+
+        assert settings.key == "value"
+        assert settings.number == 789
+        assert settings.a_dict.nested.other_level == "nested value"
+        assert settings['a_boolean'] is False
+        assert settings.get("DONTEXIST", default=1) == 1
+        ```
+
+    === "config.py"
+        Neste arquivo a nova instância do objeto *setings* de **Dynaconf** é inicializada e configurada.
+        ```python
+        from dynaconf import Dynaconf
+
+        settings = Dynaconf(
+            settings_files=['settings.toml', '.secrets.toml'],
+        )
+        ```
+        Mais opções são descritas em [Dynaconf Configuration](/configuration/)
+
+    === "settings.toml"
+        **Opcionalmente** armazene as configurações em um arquivo (ou em múltiplos arquivos)
+        ```toml
+        key = "value"
+        a_boolean = false
+        number = 1234
+        a_float = 56.8
+        a_list = [1, 2, 3, 4]
+        a_dict = {hello="world"}
+
+        [a_dict.nested]
+        other_level = "nested value"
+        ```
+        Mais detalhes em [Settings Files](/settings_files/)
+
+    === ".secrets.toml"
+        **Opcionalmente** armazene dados sensíveis em um único arquivo local chamado `.secrets.toml`
+        ```toml
+        password = "s3cr3t"
+        token = "dfgrfg5d4g56ds4gsdf5g74984we5345-"
+        message = "This file doesn't go to your pub repo"
+        ```
+
+        > ⚠️ O comando `dynaconf init` coloca o `.secrets.*` em seu `.gitignore` evitando que o mesmo seja exposto no repositório público mas é sua responsabilidade mantê-lo em seu ambiente local, também é recomendado que os ambientes de produção utilizem o suporte nativo para o serviço da Hashicorp Vault para senhas e tokens. 
+
+        ```ini
+        # Segredos não vão para o repositório público
+        .secrets.*
+        ```
+
+        Leia mais em [Secrets](/secrets/)
+
+    === "env vars"
+        **Opcionalmente** use variáveis de ambiente com prefixos. (arquivos `.env` também são suportados)
+
+        ```bash
+        export DYNACONF_NUMBER=789
+        export DYNACONF_FOO=false
+        export DYNACONF_DATA__CAN__BE__NESTED=value
+        export DYNACONF_FORMATTED_KEY="@format {this.FOO}/BAR"
+        export DYNACONF_TEMPLATED_KEY="@jinja {{ env['HOME'] | abspath }}"
+        ```
+
+    ---
+
+    > ℹ️ Você pode criar os arquivos em vez de utilizar o comando `dynaconf init` e dar qualquer nome que queira em vez do padrão `config.py` (o arquivo deve estar em seu `python path` para ser importado)