README.rst 1.54 KB
Newer Older
dboe's avatar
dboe committed
1
2
3
=====================
Introduction to `rna`
=====================
dboe's avatar
dboe committed
4

dboe's avatar
dboe committed
5

dboe's avatar
dboe committed
6
.. pypi
dboe's avatar
dboe committed
7
.. image:: https://img.shields.io/pypi/v/rna.svg
8
    :target: https://pypi.python.org/pypi/rna
dboe's avatar
dboe committed
9

dboe's avatar
dboe committed
10
11
.. ci
    .. image:: https://img.shields.io/travis/dboe/rna.svg
12
        :target: https://travis-ci.com/dboe/rna
dboe's avatar
dboe committed
13
14
.. image:: https://gitlab.mpcdf.mpg.de/dboe/rna/badges/master/pipeline.svg
    :target: https://gitlab.mpcdf.mpg.de/dboe/rna/commits/master
dboe's avatar
dboe committed
15
16

.. coverage
dboe's avatar
dboe committed
17
18
.. image:: https://gitlab.mpcdf.mpg.de/dboe/rna/badges/master/coverage.svg
    :target: https://gitlab.mpcdf.mpg.de/dboe/rna/commits/master
dboe's avatar
dboe committed
19
20

.. readthedocs
dboe's avatar
dboe committed
21
22
.. image:: https://readthedocs.org/projects/rna-docs/badge/?version=latest
    :target: https://rna-docs.readthedocs.io/en/latest/?badge=latest
dboe's avatar
dboe committed
23
    :alt: Documentation Status
dboe's avatar
dboe committed
24

dboe's avatar
dboe committed
25
26
.. pyup crosschecks your dependencies. Github is default, gitlab more complicated: https://pyup.readthedocs.io/en/latest/readme.html#run-your-first-update 
    .. image:: https://pyup.io/repos/github/dboe/rna/shield.svg
27
28
        :target: https://pyup.io/repos/github/dboe/rna/
        :alt: Updates
dboe's avatar
dboe committed
29

dboe's avatar
dboe committed
30
31
32
33
.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
   :target: https://github.com/pre-commit/pre-commit
   :alt: pre-commit

dboe's avatar
dboe committed
34
35
36

Basic and essential code building blocks of all pythons

dboe's avatar
dboe committed
37

dboe's avatar
dboe committed
38
Licensed under the ``MIT License``
dboe's avatar
dboe committed
39

dboe's avatar
dboe committed
40
41
Resources
---------
42

dboe's avatar
dboe committed
43
* Source code: https://gitlab.mpcdf.mpg.de/dboe/rna
44
* Documentation: https://rna_docs.readthedocs.io
dboe's avatar
dboe committed
45
* Pypi: https://pypi.python.org/pypi/rna
dboe's avatar
dboe committed
46

dboe's avatar
dboe committed
47

dboe's avatar
dboe committed
48
49
50
Features
--------

dboe's avatar
dboe committed
51
52
The following features should be highlighted:

dboe's avatar
dboe committed
53
* TODO