keyname 0.1.0

Easily pack and unpack metadata in a filename.

keyname

Easily pack and unpack metadata in a filename.

• Free software: MIT license

• Documentation: https://keyname.readthedocs.io.

Usage

Keyname is built around the following file name convention:

• key/value pairs are constructed with = between the key and value

• key/value pairs are joined by +

• key/value pairs are ordered alphanumerically by key

  • keys beginning with _ are ordered after keys not beginning with _

  • the ext (extension) key is always placed last

  • the key _ is reserved for the original filename

For example, key1=val1+key2=val2+_key3=val3+ext=.txt.

from keyname import keyname as kn

# returns 'key1=val1+key2=val2+_key3=val3+ext=.txt'
kn.pack({
  'key2' : 'val2',
  'ext' : '.txt',
  'key1' : 'val1',
  '_key3' : 'val3',
})

# returns {'key' : 'val', 'ext' : '.txt', '_' : 'path/to/key=val+ext=.txt'}
kf.unpack('path/to/key=val+ext=.txt')

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.0.0 (2019-03-16)

• First release on PyPI.