Package: odML
odML (Open metaData Markup Language) core libraryThe open metadata Markup Language is a file based format (XML, JSON, YAML) for storing
metadata in an organised human- and machine-readable way. odML is an initiative to define
and establish an open, flexible, and easy-to-use format to transport metadata.The Python-odML library can be easily installed viapip. The source code is freely
available onGitHub. If you are not familiar
with the version control systemgit, but still want to use it, have a look at the
documentation available on thegit-scm website.odML Project pageMore information about the project including related projects as well as tutorials and
examples can be found at our odMLproject page.Getting startedInstallationpython-odmlis most conveniently installed via pip.pip install odmlTo install the latest development version of odml you can use the git installation option of pip:pip install git+https://github.com/G-Node/python-odmlPlease note that this version might not be stable.Tutorial and examplesWe have assembled a set oftutorials.Python convenience scriptsThe Python installation features multiple convenience commandline scripts.odmlconvert: Converts odML files of previous file versions into the current one.odmltordf: Converts odML files to the supported RDF version of odML.odmlview: Render and browse local XML odML files in the webbrowser.All scripts provide detailed usage descriptions by adding thehelpflag to the command.odmlconvert -h
odmltordf -h
odmlview -hBreaking changesodML Version 1.4 introduced breaking format and API changes compared to the previous
versions of odML. Files saved in the previous format versions can be converted to a 1.4
compatible format using the version converter from the odml/tools package.Be aware that the value dtypebinaryhas been removed. Incorporating actual binary
data into odML files is discouraged, provide references to the original files using theURLdtype instead.For details regarding the introduced changes please check thegithub
release notes.DependenciesPython 3.7+Python packages:lxml (version 3.7.2)yaml (version >= 5.1)rdflib (version >=4.2.2)These packages will be downloaded and installed automatically if thepipmethod is used to install odML. Alternatively, they can be installed from the OS
package manager. On Ubuntu, they are available as:python-lxmlpython-yamlpython-rdflibIf you prefer installing using the Python package manager, the following packages are
required to build the lxml Python package on Ubuntu 14.04:libxml2-devlibxslt1-devlib32z1-devPrevious Python versionsPython 2 has reached end of life. Current and future versions of odml are not Python 2 compatible. We removed support
for Python 2 in August 2020 with version 1.5.2. We also recommend using a Python version >= 3.7. If a
Python version < 3.7 is a requirement, the following dependency needs to be installed as well:pip installenum34 (version 0.4.4)apt installpython-enumBuilding from sourceTo download the Python-odML library please either use git and clone
the repository from GitHub:$ git clone https://github.com/G-Node/python-odml.gitIf you don't want to use git download the ZIP file also provided on
GitHub to your computer (e.g. as above on your home directory under a "toolbox"
folder).To install the Python-odML library, enter the corresponding directory and run:$ cd python-odml
  $ python setup.py installNoteThe master branch is our current development branch, not all features might be
working as expected. Use the release tags instead.Contributing and GovernanceSee theCONTRIBUTINGdocument
for more information on this.Bugs & QuestionsShould you find a behaviour that is likely a bug, please file a bug report atthe github bug tracker.If you have questions regarding the use of the library, feel free to join the#gnodeIRC channel on freenode.