Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/twardoch/yaplon
Python 3-based commandline converter YAML ↔ JSON ↔ PLIST
https://github.com/twardoch/yaplon
cli convert json plist python yaml
Last synced: about 1 month ago
JSON representation
Python 3-based commandline converter YAML ↔ JSON ↔ PLIST
- Host: GitHub
- URL: https://github.com/twardoch/yaplon
- Owner: twardoch
- License: mit
- Created: 2019-07-27T14:36:06.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-10T05:54:41.000Z (over 2 years ago)
- Last Synced: 2024-04-24T21:00:44.702Z (10 months ago)
- Topics: cli, convert, json, plist, python, yaml
- Language: Python
- Homepage: https://twardoch.github.io/yaplon/
- Size: 82 KB
- Stars: 12
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# yaplon
Convert between JSON, YAML and PLIST (binary and XML) in the commandline.
Can be used in piping. Written in Python 3.9 (not 2.7 compatible).
- Copyright (c) 2021 Adam Twardoch
- Copyright (c) 2012-2015 Isaac Muse
- [MIT license](./LICENSE)
- Based on [Serialized Data Converter for Sublime Text](https://github.com/facelessuser/SerializedDataConverter)
## Installation
- Install the [release version](https://pypi.org/project/yaplon/):
```
pip3 install --user --upgrade yaplon
```
- Install the [development version](https://github.com/twardoch/yaplon):
```
pip3 install --user --upgrade git+https://github.com/twardoch/yaplon
```
## Usage
```
yaplon [c|j|p|x|y]2[j|p|x|y] -i input -o output [options]
```
### Commands:
```
c2j -i CSV -o JSON [-d DIALECT] [-k KEY] [-m] (minify)
c2p -i CSV -o PLIST [-d DIALECT] [-k KEY] [-m] (minify)
c2x -i CSV -o XML [-d DIALECT] [-k KEY] [-m] (minify) [-S] (simple XML)
c2y -i CSV -o YAML [-d DIALECT] [-k KEY] [-m] (minify)
j2p -i JSON -o PLIST [-b] (make binary PLIST)
j2x -i JSON -o XML [-m] (minify) [-S] (simple XML)
j2y -i JSON -o YAML [-m] (minify YAML)
p2j -i PLIST -o JSON [-m] (minify) [-b] (keep binary)
p2x -i PLIST -o XML [-m] (minify) [-S] (simple XML)
p2y -i PLIST -o YAML [-m] (minify YAML)
x2j -i XML -o JSON [-m] (minify) [-b] (keep binary)
x2p -i XML -o PLIST [-b] (make binary PLIST)
x2y -i XML -o YAML [-m] (minify YAML)
y2j -i YAML -o JSON [-m] (minify) [-b] (keep binary)
y2p -i YAML -o PLIST [-b] (make binary PLIST)
y2x -i YAML -o XML [-m] (minify) [-S] (simple XML)
```
Also installs direct CLI tools that correspond to the commands:
- `csv22json`, `csv22plist`, `csv22xml`, `csv22yaml`,
- `json22plist`, `json22xml`, `json22yaml`,
- `plist22json`, `plist22xml`, `plist22yaml`,
- `xml22json`, `xml22plist`, `xml22yaml`,
- `yaml22json`, `yaml22plist`, `yaml22xml`
Note that they have `22` rather than `2` in the filenames, so they don’t conflict with other similar (often single-purpose) tools that you may have.
## Examples
### JSON to YAML
File to file via the dedicated CLI tool:
```
$ json22yaml -i input.json -o output.yaml
```
Using pipe redirects, via the yaplon tool with j2y command:
```
$ yaplon j2y < input.json > output.yaml
```
Read file, output minified to stdout, via the Python 3 module
```
$ python3 -m yaplon j2y -m -i input.json
```
### PLIST to JSON
Read PLIST file, output minified JSON file, via the dedicated CLI tool.
```
$ plist22json -m -i input.plist > output.json
```
Read plist file, output minified JSON to stdout, via the yaplon tool with p2j command.
```
$ yaplon p2j -m -i input.plist
```
## Changelog
- 1.5.7: switched to Unicode output in JSON, refactoring
- 1.5.3: added CSV reading and limited XML read/write
- 1.2.7: removed obsolete plistlib.Data reference
- 1.2.3: bugfix
- 1.2.1: added support for orderedattrdict.AttrDict
- 1.1.0: added -s for sorting data
- 1.0.8: initial public release
## Links
- Project homepage: [https://twardoch.github.io/yaplon/](https://twardoch.github.io/yaplon/)
- Python package on PyPi: [https://pypi.org/project/yaplon/](https://pypi.org/project/yaplon/)
- Source on Github: [https://github.com/twardoch/yaplon](https://github.com/twardoch/yaplon)
- Donate via [https://www.paypal.me/adamtwar](https://www.paypal.me/adamtwar)