sphinx-quickstart on Mon Apr 16 21:03:36 2018. You can adapt this file completely to your liking, but it should at least contain the root toctree directive.
Welcome to HER’s documentation!¶
her¶
It contains the main functions used to convert an HER string to a dictionary and viceversa.
HER, a new Text Format 
¶
Search informations about the Syntax and Types using the Wiki section.
Content table¶
What’s HER?¶
HER is text format, like XML/Json. The difference is that HER is easier than others. Just see:
- Category -
>> Array[]
* Array[] = "Umh, that's pretty good!"
Why shall I use HER?¶
As I said before, HER is simple and easy to use. You can pass informations, or better, store informations* and document them.
Feel the difference:
XML:
<christmas>
<greetings>Merry christmas!</greetings>
<greetings>Spam, Python, Eggs</greetings>
</christmas>
HER:
- Christmas -
>> Greetings[]
* Greetings[] = "Merry christmas!"
* Greetings[] = "Spam, Python, Eggs"
Python Module¶
Installation¶
You can easily install that module using pip:
pip install her
Or, if you want to upgrade the module:
pip install --upgrade her
Encode a Dictionary¶
Just use the encode function.
from her import encode
her = encode({'Category':{'hello world':True}})
print(her)
Output:
- Category -
* hello world = True
Decode a String¶
Just use the decode function.
from her import decode
dictionary = decode("- Category -\n * hello world = True")
print(dictionary)
Output:
{'Category':{'hello world':True}}
HER class¶
You can use the HER class to call less
encode & decode functions and optimize
your codebase. It updates all its attributes
automatically.
x = her.HER()
x.value = {"foo": {"lol": 1}}
print(repr(x.representation)) # Output: '- foo -\n * lol = 1'
You can also pass a parameter (dict or str):
x = her.HER('- foo -\n * lol = 1')
print(x.value) # Output: {"foo": {"lol": 1}}
y = her.HER({"foo": {"lol": 1}})
print(repr(x.representation)) # Output: '- foo -\n * lol = 1'