Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
cthoyt committed May 8, 2018
1 parent c89b800 commit 8033f39
Showing 1 changed file with 54 additions and 5 deletions.
59 changes: 54 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,42 @@
Bio2BEL ChEBI |build| |coverage| |docs|
=======================================
Bio2BEL ChEBI |build| |coverage| |docs| |zenodo|
================================================
Convert the ChEBI ontology and related chemical information to BEL.

Installation
------------
:code:`python3 -m pip install git+https://github.com/bio2bel/chebi.git`

Installation |pypi_version| |python_versions| |pypi_license|
------------------------------------------------------------
``bio2bel_chebi`` can be installed easily from `PyPI <https://pypi.python.org/pypi/bio2bel_chebi>`_ with
the following code in your favorite terminal:

.. code-block:: sh
$ python3 -m pip install bio2bel_chebi
or from the latest code on `GitHub <https://github.com/bio2bel/chebi>`_ with:

.. code-block:: sh
$ python3 -m pip install git+https://github.com/bio2bel/chebi.git@master
Setup
-----
chebi can be downloaded and populated from either the Python REPL or the automatically installed command line
utility.

Python REPL
~~~~~~~~~~~
.. code-block:: python
>>> import bio2bel_chebi
>>> chebi_manager = bio2bel_chebi.Manager()
>>> chebi_manager.populate()
Command Line Utility
~~~~~~~~~~~~~~~~~~~~
.. code-block:: bash
bio2bel_chebi populate
.. |build| image:: https://travis-ci.org/bio2bel/chebi.svg?branch=master
:target: https://travis-ci.org/bio2bel/chebi
Expand All @@ -17,3 +49,20 @@ Installation
.. |docs| image:: http://readthedocs.org/projects/bio2bel-chebi/badge/?version=latest
:target: http://bio2bel.readthedocs.io/projects/chebi/en/latest/?badge=latest
:alt: Documentation Status

.. |climate| image:: https://codeclimate.com/github/bio2bel/chebi/badges/gpa.svg
:target: https://codeclimate.com/github/bio2bel/chebi
:alt: Code Climate

.. |python_versions| image:: https://img.shields.io/pypi/pyversions/bio2bel_chebi.svg
:alt: Stable Supported Python Versions

.. |pypi_version| image:: https://img.shields.io/pypi/v/bio2bel_chebi.svg
:alt: Current version on PyPI

.. |pypi_license| image:: https://img.shields.io/pypi/l/bio2bel_chebi.svg
:alt: MIT License

.. |zenodo| image:: https://zenodo.org/badge/97003706.svg
:target: https://zenodo.org/badge/latestdoi/97003706
:alt: Zenodo DOI

0 comments on commit 8033f39

Please sign in to comment.