Skip to main content

Transform JSON Objects to human readable strings

Project description

Build Status

Human JSON

human_json is a simple python library, that can take a JSON Object, and create a pretty string for that object.

JSON is easy to transport, and quite easy to read, but requires some form of prior training to properly understand it. This library allows one to transform JSON Objects into an easier to read format

Example

The following Python dictionary (which can represent a JSON Object):

{
    'className': 'ComputerScience',
    'classId': 2020,
    'assignments': {
        'assignment1': {
            'average_grade': 5.5,
            'description': 'Complete Assignment 1',
            'grades': [5, 5, 5, 7]
        },
        'assignment2': {
            'average_grade': None,
            'description': 'Complete Assignment 2',
            'grades': ()
        }
    },
    'students': ('student1', 'student2', 'studentabc', 2019, None, 10.5),
}

turns into the following pretty string:

className: ComputerScience
classId: 2020
assignments:
	assignment1:
		average_grade: 5.5
		description: Complete Assignment 1
		grades:
			5
			5
			5
			7
	assignment2:
		average_grade: None
		description: Complete Assignment 2
		grades:
students:
	student1
	student2
	studentabc
	2019
	None
	10.5

Custom Prefixes

You can also specify an optional prefix, that will be prefixed to each line. A possible prefix is "* ". Using this prefix, will return a markdown list. This can be directly copy-pasted into a markdown file, for example:

  • className: ComputerScience
  • classId: 2020
  • assignments:
    • assignment1:
      • average_grade: 5.5
      • description: Complete Assignment 1
      • grades:
        • 5
        • 5
        • 5
        • 7
    • assignment2:
      • average_grade: None
      • description: Complete Assignment 2
      • grades:
  • students:
    • student1
    • student2
    • studentabc
    • 2019
    • None
    • 10.5

Custom Indentations

You can also specify a custom indentation. The default is \t, but you can specify or even a number of spaces. Below is an example using 2:

className: ComputerScience
classId: 2020
assignments:
  assignment1:
    average_grade: 5.5
    description: Complete Assignment 1
    grades:
      5
      5
      5
      7
  assignment2:
    average_grade: None
    description: Complete Assignment 2
    grades:
students:
  student1
  student2
  studentabc
  2019
  None
  10.5

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

human-json-0.1.2.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

human_json-0.1.2-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file human-json-0.1.2.tar.gz.

File metadata

  • Download URL: human-json-0.1.2.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.6.8 Linux/4.4.0-17763-Microsoft

File hashes

Hashes for human-json-0.1.2.tar.gz
Algorithm Hash digest
SHA256 7674d5239fbf2e1e3babad72c44983574780151008a0bfd168f4cf8aa832d08e
MD5 e63cbe02c46b32cfb0c842040ee90948
BLAKE2b-256 097f8bad967052f2dee5600137a27c741c996c6af6ee47fd12e5e3c51b44385c

See more details on using hashes here.

File details

Details for the file human_json-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: human_json-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 3.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.6.8 Linux/4.4.0-17763-Microsoft

File hashes

Hashes for human_json-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 aeebcc2e6eb02f60817e9ac7178c301ff95529322bd1ceeb8262b18f32600745
MD5 1a29b3b0e23b88fcd6b20b0fcda58aac
BLAKE2b-256 422e25f86e399bae2501fa61c762ee7a19a1345deee31059776d4f2e36e1b2f0

See more details on using hashes here.

Supported by

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