Skip to main content

Smudge and Clean filters for Power BI-generated JSON files.

Project description

PBIP Tools

Python 3.12 License: MIT Ruff pre-commit

PBIP-tools is a Python package designed to process Power BI-generated JSON files for enhanced human-readability and seamless version control integration. The package provides two key executables:

  1. json-clean: Converts nested and complex Power BI-generated JSON files into a human-readable format.

  2. json-smudge: Reverses the cleaning process, restoring the JSON files to a format that Power BI can properly load.

Features

  • Human-readable JSON: The json-clean utility de-nests JSON objects and JSON strings for easier understanding and editing.

  • Restoration for Power BI: The json-smudge utility ensures that files cleaned by json-clean can be reloaded into Power BI.

  • Command-line utilities: Both json-clean and json-smudge can be used directly from the command line for seamless file processing.

Installation

You can install the package using pip:

pip install pbip-tools

Usage

Cleaning a JSON File

To clean a Power BI-generated JSON file for readability, run the following command:

json-clean <file-or-glob> [<file-or-glob2> ... ]

Example:

json-clean report.json my_folder/*.json

Smudging a JSON File

To restore a cleaned JSON file to its original state for Power BI loading, run:

json-smudge <file-or-glob> [<file-or-glob2> ...]

Example:

json-smudge cleaned_report.json cleaned/**/*.json

Dependencies

This package depends solely on Python’s standard libraries. For contributing and testing, pre-commit and pytest may be required.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

If you would like to contribute, feel free to open issues or submit pull requests.

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

pbip_tools-0.0.4.1.tar.gz (5.7 MB view details)

Uploaded Source

Built Distribution

pbip_tools-0.0.4.1-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

Details for the file pbip_tools-0.0.4.1.tar.gz.

File metadata

  • Download URL: pbip_tools-0.0.4.1.tar.gz
  • Upload date:
  • Size: 5.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for pbip_tools-0.0.4.1.tar.gz
Algorithm Hash digest
SHA256 d0bbfe8f5e8817db965b94d209b497443e1339872976bf5c7d64c86e57389356
MD5 e9720d54e34b09be2bf5dbedc17f6d3b
BLAKE2b-256 296f7d66d185028649bf49633811aa25b8a8f455fd299389099ffa635de15edf

See more details on using hashes here.

File details

Details for the file pbip_tools-0.0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pbip_tools-0.0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 78b39ba3174ae032dfcb4d26712367f1e983ee46a5faa8749919998bf6879507
MD5 f411984dc50efeecddcc00e6afba84d3
BLAKE2b-256 fe1139ceaec1eb2802e601b06e1472a1f8d4f7b4c49922effbe4503a6fb66739

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