Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/decryptus/json-dotenv

Manipulate and extract envfiles in json format.
https://github.com/decryptus/json-dotenv

cli dotenv envfile environment-variables json python

Last synced: 3 months ago
JSON representation

Manipulate and extract envfiles in json format.

Host: GitHub
URL: https://github.com/decryptus/json-dotenv
Owner: decryptus
License: gpl-3.0
Created: 2019-03-02T05:16:06.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-04-26T18:33:20.000Z (over 1 year ago)
Last Synced: 2024-03-25T20:01:21.689Z (8 months ago)
Topics: cli, dotenv, envfile, environment-variables, json, python
Language: Python
Homepage:
Size: 60.5 KB
Stars: 8
Watchers: 2
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE

Awesome Lists containing this project

awesome-json - json-dotenv - Manipulate and extract envfiles in json format. (Command-line tools)

README

# json-dotenv project

[![PyPI pyversions](https://img.shields.io/pypi/pyversions/json-dotenv.svg)](https://pypi.org/project/json-dotenv/)
[![PyPI version shields.io](https://img.shields.io/pypi/v/json-dotenv.svg)](https://pypi.org/project/json-dotenv/)
[![Documentation Status](https://readthedocs.org/projects/json-dotenv/badge/?version=latest)](https://json-dotenv.readthedocs.io/)

json-dotenv is a free and open-source, we develop it to manipulate and extract envfiles in json format.

## Table of contents
1. [Installation](#installation)
2. [Usage](#usage)
3. [Commands](#commands)

## Installation

`pip install json-dotenv`

## Usage

```
usage: json-dotenv [-h] [--allow-envvar] [-c {list,keys,get,set,unset}]
[-k KEY] [-v VALUE] [-f FILE] [--force]
[-l {critical,error,warning,info,debug}]
[--logfile LOGFILE] [-o OUTPUT] [-q {always,never,auto}]
[--format {env,json}]
[{list,keys,get,set,unset}]

positional arguments:
{list,keys,get,set,unset}
Commands: list, keys, get, set, unset

optional arguments:
-h, --help show this help message and exit
--allow-envvar Allow environment variables expansion, instead of
False
-c {list,keys,get,set,unset}
Commands: list, keys, get, set, unset, instead of list
(deprecated)
-k KEY, --key KEY variable name to set or unset
-v VALUE, --value VALUE
variable value to set
-f FILE Location of the environment file or from stdin (-),
instead of .env
--force Force the output even if there is an error
-l {critical,error,warning,info,debug}, --loglevel {critical,error,warning,info,debug}
Emit traces with LOGLEVEL details, must be one of:
critical, error, warning, info, debug
--logfile LOGFILE Use log file instead of /var/log/json-dotenv
/json-dotenv.log
-o OUTPUT Output result in file or to stdout
-q {always,never,auto}
Whether to quote or not the variable values, instead
of always. This does not affect parsing
--format {env,json} Output format env or json, instead of json

```

## Commands

List all environment variables in file foo.env:

`json-dotenv list -f foo.env`

```json
{
"LANG": "en_US.utf8",
"PATH": "/usr/local/bin:/usr/bin:/bin:/usr/local/games:/usr/games",
"MONIT_DOCKER_CONFIG": "vars:\n base_url_unix: unix:///var/run/docker.sock\n base_url_https: https://127.0.0.1:2376/\n tls_verify: true\nclients:\n '@import_client':\n - clients.yml.example\n local_https:\n config:\n base_url: ${vars['base_url_https']}\n tls:\n verify: ${vars['tls_verify']}\n foo_https:\n '@import_vars': foo_https.vars.yml.example\n config:\n base_url: ${vars['base_url_https']}\nctn-groups:\n php:\n match:\n - 'name:foo-php*'\n - 'image:*/php-fpm/*'\n - 'label:*php-fpm*'\n nodejs:\n match:\n - 'id:4c01db0b339c'\n - 'name:node*'\nconditions:\n mem_gt_10pct_and_cpu_gt_60pct:\n expr:\n - mem_percent > 10\n - cpu_percent > 60\n mem_usage_100MiB:\n expr:\n - mem_usage > 100 MiB\n status_not_running:\n expr:\n - status not in (pause,running)\ncommands:\n start_pause:\n exec:\n - start\n - (echo 'foo' > /tmp/bar)\n - pause\n pause_restart:\n exec:\n - pause\n - restart\n remove_force:\n exec:\n - remove:\n kwargs:\n force: true",
"SHELL": "/bin/bash",
"AUTON_CONFIG": "general:\n listen_addr: 0.0.0.0\n listen_port: 8666\n max_workers: 5\n max_requests: 5000\n max_life_time: 3600\n lock_timeout: 60\n charset: utf-8\n content_type: 'application/json; charset=utf-8'\n #auth_basic: 'Restricted'\n #auth_basic_file: '/etc/auton/auton.passwd'\nendpoints:\n si.corp-ansible:\n plugin: subproc\n config:\n prog: ansible-playbook\n timeout: 3600\n si.corp-terraform:\n plugin: subproc\n config:\n prog: terraform\n timeout: 3600\n curl:\n plugin: subproc\n config:\n prog: curl\n timeout: 3600\nmodules:\n job:\n routes:\n run:\n handler: 'job_run'\n regexp: '^run/(?P[^\\/]+)/(?P[a-z0-9][a-z0-9\\-]{7,63})$'\n safe_init: true\n auth: false\n op: 'POST'\n status:\n handler: 'job_status'\n regexp: '^status/(?P[^\\/]+)/(?P[a-z0-9][a-z0-9\\-]{7,63})$'\n auth: false\n op: 'GET'"
}
```

List all environment variables name in file foo.env:

`json-dotenv keys -f foo.env`

```json
[
"LANG",
"PATH",
"MONIT_DOCKER_CONFIG",
"SHELL",
"AUTON_CONFIG"
]
```

Get foo.env contents from stdin and set variables AUTON\_CONFIG=bar and toto=titi:

`cat foo.env | json-dotenv set -f - -k AUTON_CONFIG -v bar -k toto -v titi`

Get variables LANG and PATH from foo.env:

`json-dotenv get -f foo.env -k LANG -k PATH`

```json
{
"LANG": "en_US.utf8",
"PATH": "/usr/local/bin:/usr/bin:/bin:/usr/local/games:/usr/games"
}
```

Unset variables MONIT\_DOCKER\_CONFIG and AUTON\_CONFIG from file foo.env (file not modified):

`json-dotenv unset -f foo.env -k MONIT_DOCKER_CONFIG -k AUTON_CONFIG`

```json
{
"LANG": "en_US.utf8",
"PATH": "/usr/local/bin:/usr/bin:/bin:/usr/local/games:/usr/games",
"SHELL": "/bin/bash"
}
```

Set variables TOTO and BAR and output result in file bar.json:

`json-dotenv set -f '' -k TOTO -v tutu -k BAR -v foo -o bar.json`

Set variables TOTO and BAR and output result in file bar.env (environment variables format):

`json-dotenv set -f '' -k TOTO -v tutu -k BAR -v foo --format env -o bar.env`