jsave 1.1.0

A simple python module for saving data to JSON files

JSave

JSave is a simple python module for saving data to 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.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

Save

The save function is used to save data - dict to a filepath - str.

from jsave import save

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

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

Read

The read function is used to read data from a filepath - str.

from jsave import read

print(read("save.json"))
# {"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 read

print(read("save.json", 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 read

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

Delete

The read function is used to delete a file provided by filepath - str.

from jsave import delete

delete("save.json")
# file is deleted

Merge

The merge function is used to combine multiple files - [str] and save to a output_filepath - str.

from jsave import merge

merge(["save.json", "newsave.json"], "output.json")
# new file named output.json with contents of both save.json and newsave.json.

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)