The main idea of the Storer is to provided only few methods for powerful manipulating and keeping the data in the files.
Particularly methods put and get are enough for quick start.
pip3 install storer
- Create an Storer instance:
s = Storer() - Put something:
s.put(what=<what_ever_you_like>, name=<name_of_object>) - Get something:
s.get(name=<name_of_object>) - Look at internal data of the instance:
s.show()oroutput = s.show(get_string=True)
>>> from storer import Storer
>>> s = Storer()
>>> s.put(what="string", name="my_string")
>>> s.get(name="my_string")
'string'
>>> >>> from storer import Storer
>>> s = Storer(dump_path="~/my_folder_for_dumps", dump_name="dumps", verbose=True)
[Storer v.X.Y.Z [XYZ]] is initialized!
Dump folder: [~/my_folder_for_dumps]
[Storer] No data is available for loading...
>>> s.put(what=[i for i in range(10)], name="my_range")
>>> s.put(what={v:v*2 for v in range(5)}, name="my_dict")
>>> s.dump()
[Storer] ~/my_folder_for_dumps dumps dumping... # at this point you have you data stored in the file with name 'dumps' at folder '~/my_folder_for_dumps'
>>> However you can use just put methods and Storer will dump your data automatically:
>>> from storer import Storer
>>> s = Storer(dump_path="~/my_folder_for_dumps", dump_name="dumps", verbose=True)
[Storer v.X.Y.Z [XYZ]] is initialized!
Dump folder: [~/my_folder_for_dumps]
[Storer] No data is available for loading...
>>> s.put(what=[i for i in range(10)], name="my_range")
>>> s.put(what={v:v*2 for v in range(5)}, name="my_dict")
>>> exit()
[Storer] ~/my_folder_for_dumps dumps dumping...It is possible to disable this feature by providing exit_dump=False flag.
Feel free to contribute to the project, but please initially create an issue with detailed problem and way how to resolve it.
MIT