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.

HER, a new Text Format Build Status

Search informations about the Syntax and Types using the Wiki section.

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:


    <greetings>Merry christmas!</greetings>
    <greetings>Spam, Python, Eggs</greetings>


- Christmas -
    >> Greetings[]
    * Greetings[] = "Merry christmas!"
    * Greetings[] = "Spam, Python, Eggs"

Why HER?

Because, however, if it isn’t right, it’s right. (just joking)

Python Module


You can easily install that module using PiP:

pip install her

Or, if you want to upgrade the module:

pip install --upgrade her

Import Module

You must use import her to import all HER module.

import her

Encode a Dictionary

Just use the encode function.

from her import encode
her = encode({'Category':{'hello world':True}})


- Category -
    * hello world = True

Decode a String

Just use the decode function.

from her import decode
dictionary = decode("- Category -\n    * hello world = True")


{'Category':{'hello world':True}}

HER class

You can use the HER class to call less encode & decode functions an 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'

Indices and tables