Skip to main content

Easily pack and unpack metadata in a filename.

Project description


.. image::

.. image::

.. image::
:alt: Documentation Status

Easily pack and unpack metadata in a filename.

* Free software: MIT license
* Documentation:


Keyname is built around the following file name convention:

* key/value pairs are constructed with :code:`=` between the key and value
* key/value pairs are joined by :code:`+`
* key/value pairs are listed by alphanumerical ordering of the key
* keys beginning with :code:`_` are ordered after keys not beginning with :code:`_`
* the :code:`ext` (extension) key is always placed last

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

.. code-block:: python3
from keyname import keyname as kn

# returns 'key1=val1+key2=val2+_key3=val3+ext=.txt'
'key2' : 'val2',
'ext' : '.txt',
'key1' : 'val1',
'_key3' : 'val3',

# returns {'key' : 'val', 'ext' : '.txt'}


This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter:
.. _`audreyr/cookiecutter-pypackage`:


0.0.0 (2019-03-16)

* First release on PyPI.

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

keyname-0.0.2.tar.gz (9.4 kB view hashes)

Uploaded Source

Built Distribution

keyname-0.0.2-py2.py3-none-any.whl (4.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page