Skip to main content

No project description provided

Project description


Build Status

Synchronize data structure with markup file

Currently supported formats: YAML, JSON, Pickle

Main features:

  • Work with Connection object as usual data structure. You can use features like array slices or methods of dict and list
  • JS-like accessing ( instead of foo['bar']['buzz'])
  • Mutations logging via logging module. Example below
  • Reload on file change (pass reload=False to connection constructor to disable)
  • Update file on every change (pass save=False to connection constructor to disable)
  • Immutable connections (pass mutable=False to connection constructor to enable)


pip install hotmarkup



from hotmarkup import JsonConnection

connection = JsonConnection('example.json', default={'changed': False})
print(connection.changed)  # Out: False
with open('example.json', 'w') as f:
    f.write('{"changed": true}')
print(connection.changed)  # Out: True


from hotmarkup import JsonConnection

connection = JsonConnection('example.json', default={'changed': False})
print(open('example.json').read())  # Out: {"changed": false}
connection.changed = True
print(open('example.json').read())  # Out: {"changed": true}


import logging
from hotmarkup import YamlConnection

connection = YamlConnection('example.yaml', default={'something_important': 'old_value'})
connection.something_important = 'new_value'


INFO:example.yaml:Mutation UPDATE example.yaml.something_important=new_value


from hotmarkup import YamlConnection

connection = YamlConnection('counter.yaml', default={'counter': 0})
connection.counter += 1
print(f'You run this program {connection.counter} times')

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hotmarkup-0.1.9.tar.gz (6.3 kB view hashes)

Uploaded source

Built Distribution

hotmarkup-0.1.9-py3-none-any.whl (7.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page