jsave

JSave

JSave is a simple python module for operating on JSON files.

Table of Contents

• Install
• Quick Start
• Docs
• Contributing

Install

To install JSave use pip.

pip3 install jsave

Quick Start

To get started with JSave first import functions from jsave into your project like this.

from jsave import FUNCTIONS_HERE

To find out what to import, and how to use JSave check out the docs.

Docs

JFile/JSONFile

The JFile class is what it sounds like, providing all the neccessary methods to manipulate the specified filepath.

Args:

filepath (string)

Save

Saves a python dict to filepath as JSON data

Args:

data (dict)

indent (int) = 4

Returns:

JData that was written to file

from jsave import JFile

data = {
    "This is some dict in python": "It is very cool"
}

file = JFile("save.json")

# save data as JSON to file save.json
file.save(data, 4)

Read

Reads a JSON file.

Args:

keys (StringList) = []

safe_mode (bool) = True

Returns:

JSONData from file

from jsave import JFile

file = JFile("save.json")

print(file.read())
# {"This is some sample data": "Indeed it is"}

If you only want to grab specific keys you can specify them with the keys - [str] parameter.

from jsave import JFile

file = JFile("save.json")

print(file.read(keys=["Hello"]))
# {"Hello": "World"}

If one of the keys you're searching for dosent exist then you'll get an error like this.

Exception: 'World' could not be loaded, please make sure it is in 'save.json'
(or set parameter 'safe_mode' to False)

If you would like to skip over keys the read function cant find, set safe_mode - bool to False.

from jsave import JFile

file = JFile("save.json")

print(file.read(keys=["Hello", "Guy"], safe_mode=False))
# Cannot find key Guy, but safe_mode is False so it skips over it.
# {"Hello": "World"}

Delete

Delete a file at the specified filepath.

from jsave import JFile

file = JFile("save.json")

file.delete()
# file is deleted

Update

Update value at key for specified filepath.

Args:

key (str)

value (object)

from jsave import JFile

file = JFile("save.json")

file.update("Hello/World", 10)

print(file.read())
# {"will not overwrite": true, "Hello":{"World": 10}}

JData

JData contains a variety of methods to use on JSON Data

Args: data (str || dict)

from jsave import JData, JFile

# from string
stringdata = '{"Im some": "Json Data"}'
jdata = JData(stringdata)

# from read
file = JFile("save.json")
jdata = file.read()

# from dict
somedata = {
    "Hello": "World"
}

jdata = JData(somedata)

prettify

Returns JData with formating

Args: indent (int) = 4

Returns: JData as str with formmating

from jsave import JData

# from dict
somedata = {"Hello": "World"}

jdata = JData(somedata)

print(jdata.prettify())
#output:
#{
#    "Hello": "World"
#}

print(jdata.prettify(indent=2))
#output:
#{
#  "Hello": "World"
#} 

set_value

The set_value method works in a similar way to setting keys for dicts with some added comfort featues

Args: key (str) value (object)

Set a single value

from jsave import JData

# from dict
somedata = {"Hello": "World"}

jdata = JData(somedata)

jdata.set_value("Hello", 10)

print(jdata)
# {"Hello": 10}

Set a nested value

from jsave import JData

# from dict
somedata = {
    "Hello": {
        "World": 10
    }
}

jdata = JData(somedata)

jdata.set_value("Hello/World", 467)

print(jdata)
# {"Hello": {"World": 467}}

Set a value that dosent exist

from jsave import JData

# from dict
somedata = {}

jdata = JData(somedata)

jdata.set_value("Hello/World", 467)

print(jdata)
# {"Hello": {"World": 467}}

get_value

The get_value method works in a similar way to getting keys from a dict

Args: key (str)

Returns: Value at key

from jsave import JData

# from dict
somedata = {
    "Hello": {
        "World": 10
    }
}

jdata = JData(somedata)

print(jdata.get_value("Hello/World"))
# 10

Contributing

All types of contibutions are welcome for the JSave project, whether its updating the documentation, reporting issues, or simply mentioning JSave in your projects.

Remember this before contibuting, you should open an Issue if you don't think you can contribute and open a Pull Request if you have a patch for an issue.

Sections:

• Reporting Bugs
• Enchancements
• Improve Docs

Reporting Bugs

Before you submit a bug report make sure you have the following information or are using the following things.

• Make sure you're on the latest version.
• Make sure its not just on your end (if you were possibly using a python version we dont support).
• Check issues to see if it has already been reported.
• Collect the following info about the bug:
  • Stack Trace.
  • OS, Platform and Version (Windows, Linux, macOS, x86, ARM).
  • Possibly your input and the output.
  • Can you reliably reproduce the issue?

If you have all of that prepared you are more than welcome to open an issue for the community to take a look at.

Enchancements

If you'd like to enchance something please read this checklist:

• Make sure you're on the latest version.
• Read the docs and find out if what you want to implement is already a feature.
• Search to see if the enhancement has already been suggested (No need to open a new issue if its already there!).
• See if your improvment fits the majority of users, if instead it adds minor functionality consider making a plugin library instead.
• Describe the enchancement in detail, what does it actually do?

Improve Docs

If you'd like to improve the documentation please go over the following:

• Read the docs first! If it's already there theres no point adding it.
• Check issues for ideas, issues are a great place to find documentation to add or edit.
• Provide examples for the area youre writing for (eg. showing a code example of how to use the save function)