1- .. image :: https://travis-ci.org/G-Node/python-odml.svg?branch=master
2- :target: https://travis-ci.org/G-Node/python-odml
3- .. image :: https://ci.appveyor.com/api/projects/status/2wfvsu7boe18kwjy?svg=true
4- :target: https://ci.appveyor.com/project/mpsonntag/python-odml
5- .. image :: https://coveralls.io/repos/github/G-Node/python-odml/badge.svg?branch=master
6- :target: https://coveralls.io/github/G-Node/python-odml?branch=master
1+ ![ Travis build] ( https://travis-ci.org/G-Node/python-odml.svg?branch=master )
2+ ![ Appveyor] ( https://ci.appveyor.com/api/projects/status/2wfvsu7boe18kwjy?svg=true )
3+ ![ Test coverage] ( https://coveralls.io/repos/github/G-Node/python-odml/badge.svg?branch=master )
74
8- odML (Open metaData Markup Language) core library
9- =================================================
5+ # odML (Open metaData Markup Language) core library
106
117The open metadata Markup Language is a file based format (XML, JSON, YAML) for storing
128metadata in an organised human- and machine-readable way. odML is an initiative to define
139and establish an open, flexible, and easy-to-use format to transport metadata.
1410
15- The Python-odML library can be easily installed via :code: ` pip `. The source code is freely
16- available on ` GitHub < https://github.com/G-Node/python-odml >`_ . If you are not familiar
11+ The Python-odML library can be easily installed via ``` pip `` ` . The source code is freely
12+ available on [ GitHub] ( https://github.com/G-Node/python-odml ) . If you are not familiar
1713with the version control system ** git** , but still want to use it, have a look at the
18- documentation available on the ` git-scm website < https://git-scm.com/ >`_ .
14+ documentation available on the [ git-scm website] ( https://git-scm.com/ ) .
1915
2016
21- Breaking changes
22- ----------------
17+ # Breaking changes
18+
2319
2420odML Version 1.4 introduced breaking format and API changes compared to the previous
2521versions of odML. Files saved in the previous format versions can be converted to a 1.4
2622compatible format using the version converter from the odml/tools package.
2723
28- Be aware that the value dtype :code: ` binary ` has been removed. Incorporating actual binary
24+ Be aware that the value dtype ``` binary `` ` has been removed. Incorporating actual binary
2925data into odML files is discouraged, provide references to the original files using the
30- :code: ` URL ` dtype instead.
26+ ``` URL `` ` dtype instead.
3127
32- For details regarding the introduced changes please check the ` github release notes
33- < https://github.com/G-Node/python-odml/releases> `_ .
28+ For details regarding the introduced changes please check the [ github
29+ release notes ] ( https://github.com/G-Node/python-odml/releases ) .
3430
3531
36- Dependencies
37- ------------
32+ # Dependencies
3833
3934* Python 2.7 or 3.5
4035* Python packages:
@@ -44,7 +39,7 @@ Dependencies
4439 * yaml (version 3.12)
4540 * rdflib (version >=4.2.2)
4641
47- * These packages will be downloaded and installed automatically if the :code: ` pip `
42+ * These packages will be downloaded and installed automatically if the ``` pip `` `
4843 method is used to install odML. Alternatively, they can be installed from the OS
4944 package manager. On Ubuntu, they are available as:
5045
@@ -61,50 +56,53 @@ Dependencies
6156 * lib32z1-dev
6257
6358
64- Installation
65- ------------
59+ # Installation
60+
61+ The simplest way to install Python-odML is from PyPI using the pip tool:
6662
67- The simplest way to install Python-odML is from PyPI using the pip tool::
6863
64+ ```
6965 $ pip install odml
66+ ```
7067
71- On Ubuntu, the pip package manager is available in the repositories as :code: ` python-pip `.
68+ On Ubuntu, the pip package manager is available in the repositories as ``` python-pip `` ` .
7269
7370If this method is used, the appropriate Python dependencies are downloaded and installed
7471automatically.
7572
7673
77- Building from source
78- --------------------
74+ # Building from source
7975
80- To download the Python-odML library please either use git and clone the
81- repository from GitHub: :
76+ To download the Python-odML library please either use git and clone
77+ the repository from GitHub:
8278
79+ ```
8380 $ git clone https://github.com/G-Node/python-odml.git
81+ ```
8482
8583If you don't want to use git download the ZIP file also provided on
8684GitHub to your computer (e.g. as above on your home directory under a "toolbox"
8785folder).
8886
89- To install the Python-odML library, enter the corresponding directory and run::
87+ To install the Python-odML library, enter the corresponding directory and run:
9088
89+ ```
9190 $ cd python-odml
9291 $ python setup.py install
92+ ```
9393
9494** Note** The master branch is our current development branch, not all features might be
9595working as expected. Use the release tags instead.
9696
97- odML Project page
98- -----------------
97+ # odML Project page
9998
10099More information about the project including related projects as well as tutorials and
101- examples can be found at our odML ` project page < https://g-node.github.io/python-odml >`_ .
100+ examples can be found at our odML [ project page] ( https://g-node.github.io/python-odml ) .
102101
103- Bugs & Questions
104- ----------------
102+ # Bugs & Questions
105103
106104Should you find a behaviour that is likely a bug, please file a bug report at
107- ` the github bug tracker < https://github.com/G-Node/python-odml/issues >`_ .
105+ [ the github bug tracker] ( https://github.com/G-Node/python-odml/issues ) .
108106
109107If you have questions regarding the use of the library, feel free to join the
110- ` #gnode < http://webchat.freenode.net?channels=%23gnode >`_ IRC channel on freenode.
108+ [ #gnode] ( http://webchat.freenode.net?channels=%23gnode ) IRC channel on freenode.
0 commit comments