README.rst 1.89 KB
Newer Older
1
2
3
4
===========
py_tools_ds
===========

Daniel Scheffler's avatar
Daniel Scheffler committed
5
6
7
A collection of Python tools by Daniel Scheffler.


Daniel Scheffler's avatar
Daniel Scheffler committed
8
* Free software: GNU General Public License v3
Daniel Scheffler's avatar
Daniel Scheffler committed
9
10
* Documentation: http://danschef.gitext.gfz-potsdam.de/py_tools_ds/doc/

11

Daniel Scheffler's avatar
Daniel Scheffler committed
12
13
14
15
Status
------

.. .. image:: https://img.shields.io/pypi/v/py_tools_ds.svg
16
        :target: https://pypi.python.org/pypi/py_tools_ds
17

Daniel Scheffler's avatar
Daniel Scheffler committed
18
.. .. image:: https://img.shields.io/travis/danschef/py_tools_ds.svg
19
        :target: https://travis-ci.org/danschef/py_tools_ds
20

Daniel Scheffler's avatar
Daniel Scheffler committed
21
.. .. image:: https://readthedocs.org/projects/py-tools-ds/badge/?version=latest
22
        :target: https://py-tools-ds.readthedocs.io/en/latest/?badge=latest
23
24
        :alt: Documentation Status

Daniel Scheffler's avatar
Daniel Scheffler committed
25
.. .. image:: https://pyup.io/repos/github/danschef/py_tools_ds/shield.svg
26
     :target: https://pyup.io/repos/github/danschef/py_tools_ds/
27
28
     :alt: Updates

Daniel Scheffler's avatar
Daniel Scheffler committed
29
30
.. image:: https://gitext.gfz-potsdam.de/danschef/py_tools_ds/badges/master/build.svg
.. image:: https://gitext.gfz-potsdam.de/danschef/py_tools_ds/badges/master/coverage.svg
31

Daniel Scheffler's avatar
Daniel Scheffler committed
32
See also the latest coverage_ report.
33
34
35
36
37
38
39


Features
--------

* TODO

Daniel Scheffler's avatar
Daniel Scheffler committed
40
41
42
43
44

Installation
------------
* Use the pip-Installer:

Daniel Scheffler's avatar
Daniel Scheffler committed
45
    pip install git+https://gitext.gfz-potsdam.de/danschef/py_tools_ds.git   # for HTTPS authentification
Daniel Scheffler's avatar
Daniel Scheffler committed
46
47
48
49
50
51
52
53
54
55
56
57
58
59

    pip install git+git@gitext.gfz-potsdam.de:danschef/py_tools_ds.git   # for SSH-Key authentification


* Or clone the repository via GIT and update the PATH environment variable:

    cd /your/installation/folder

    git clone https://danschef@gitext.gfz-potsdam.de/danschef/py_tools_ds.git

    PATH=$PATH:~/path/to/your/installation/folder/py_tools_ds



60
Credits
Daniel Scheffler's avatar
Daniel Scheffler committed
61
-------
62
63
64
65
66

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

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
Daniel Scheffler's avatar
Daniel Scheffler committed
67
.. _coverage: http://danschef.gitext.gfz-potsdam.de/py_tools_ds/coverage/
68