Skip to main content

A CLI tool to edit simple JSON and YAML data files

Project description

sde

PyPI version

sde is not sed. It's a structured data editor for CLI.

Why?

Many people asked for a simple JSON in-place editing and jq was the solution:

jq '.address = "abcde"' test.json|sponge test.json

Does this seem readable or elegant to you?

sde is not a substitue for jq or sed.

It allows simple in-place JSON/YAML value changes, for simple data.

Sample JSON

{
   "name":"John",
   "age":31,
   "city":"New York",
   "extra": {
       "sex": "male"
   }
}

Sample YAML

database:
  user: example
  password: secret

Modify data

sde name Jack data.json
sde extra.sex female data.json
sde database.user john data.yml

It is possible to modify data in arrays, e.g.:

{
    "pools": [
        {
            "tls": false, 
            "rig-id": null, 
            "nicehash": false, 
            "url": "pool.hashvault.pro:80", 
            "user": "YOUR_WALLET_ADDRESS", 
            "pass": "x", 
            "enabled": true, 
            "daemon": false, 
            "algo": null, 
            "tls-fingerprint": null, 
            "keepalive": false
        }
    ],
}

Update first pool's pass value to value secret:

sde pools.0.pass secret data.json

Installation for CentOS/RHEL 7, 8 or Amazon Linux 2

sudo yum -y install https://extras.getpagespeed.com/release-latest.rpm
sudo yum -y install sde

Installation for other systems

Installing with pip is easiest:

pip install sde

Notes

Quoting is avoided for null, true, false and numeric values. To ensure that a given value is quoted, use -s (or --string) option:

sde -s key null file.json

If you must edit the file, by ensuring to update only the existing key, use -e (--must-exist) option. The program will exit without adding the key which doesn't exist.

sde -e key val file.json

TODO

Work with stdin

echo $json | sde name Jack

Query simple data

sdg name data.json

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sde-1.1.0.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

sde-1.1.0-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file sde-1.1.0.tar.gz.

File metadata

  • Download URL: sde-1.1.0.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for sde-1.1.0.tar.gz
Algorithm Hash digest
SHA256 1005a17fc45cabd9e85b3c2fbce43fe2863575c2eec25d35e27f9b84631bdf7a
MD5 08d70e53f3cb76c7361281ba72d6a5aa
BLAKE2b-256 ba376ca8c061c7e6c1ef4df007c4d7f8005d76ac5159220ac41057f1bfb03cb6

See more details on using hashes here.

File details

Details for the file sde-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: sde-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for sde-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a4de858c51154176749aa36fdb3efa513e38b5092ef5e229e62cd47603b5b681
MD5 294b287a6455cd811f62eaeb951a1c24
BLAKE2b-256 26d953c39057f9173825601e602cfcaee209e399cbd5263e0659221ac162306f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page