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 )
7
4
8
- odML (Open metaData Markup Language) core library
9
- =================================================
5
+ # odML (Open metaData Markup Language) core library
10
6
11
7
The open metadata Markup Language is a file based format (XML, JSON, YAML) for storing
12
8
metadata in an organised human- and machine-readable way. odML is an initiative to define
13
9
and establish an open, flexible, and easy-to-use format to transport metadata.
14
10
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
17
13
with 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/ ) .
19
15
20
16
21
- Breaking changes
22
- ----------------
17
+ # Breaking changes
18
+
23
19
24
20
odML Version 1.4 introduced breaking format and API changes compared to the previous
25
21
versions of odML. Files saved in the previous format versions can be converted to a 1.4
26
22
compatible format using the version converter from the odml/tools package.
27
23
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
29
25
data into odML files is discouraged, provide references to the original files using the
30
- :code: ` URL ` dtype instead.
26
+ ``` URL `` ` dtype instead.
31
27
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 ) .
34
30
35
31
36
- Dependencies
37
- ------------
32
+ # Dependencies
38
33
39
34
* Python 2.7 or 3.5
40
35
* Python packages:
@@ -44,7 +39,7 @@ Dependencies
44
39
* yaml (version 3.12)
45
40
* rdflib (version >=4.2.2)
46
41
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 `` `
48
43
method is used to install odML. Alternatively, they can be installed from the OS
49
44
package manager. On Ubuntu, they are available as:
50
45
@@ -61,50 +56,53 @@ Dependencies
61
56
* lib32z1-dev
62
57
63
58
64
- Installation
65
- ------------
59
+ # Installation
60
+
61
+ The simplest way to install Python-odML is from PyPI using the pip tool:
66
62
67
- The simplest way to install Python-odML is from PyPI using the pip tool::
68
63
64
+ ```
69
65
$ pip install odml
66
+ ```
70
67
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 `` ` .
72
69
73
70
If this method is used, the appropriate Python dependencies are downloaded and installed
74
71
automatically.
75
72
76
73
77
- Building from source
78
- --------------------
74
+ # Building from source
79
75
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:
82
78
79
+ ```
83
80
$ git clone https://github.com/G-Node/python-odml.git
81
+ ```
84
82
85
83
If you don't want to use git download the ZIP file also provided on
86
84
GitHub to your computer (e.g. as above on your home directory under a "toolbox"
87
85
folder).
88
86
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:
90
88
89
+ ```
91
90
$ cd python-odml
92
91
$ python setup.py install
92
+ ```
93
93
94
94
** Note** The master branch is our current development branch, not all features might be
95
95
working as expected. Use the release tags instead.
96
96
97
- odML Project page
98
- -----------------
97
+ # odML Project page
99
98
100
99
More 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 ) .
102
101
103
- Bugs & Questions
104
- ----------------
102
+ # Bugs & Questions
105
103
106
104
Should 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 ) .
108
106
109
107
If 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