Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cthoyt committed May 7, 2018
1 parent e03b1e5 commit 435963b
Showing 1 changed file with 48 additions and 1 deletion.
49 changes: 48 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,40 @@ This package creates:
- HGNC gene family membership BEL Script
- orthology BEL script

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

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

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

Python REPL
~~~~~~~~~~~
.. code-block:: python
>>> import bio2bel_hgnc
>>> hgnc_manager = bio2bel_hgnc.Manager()
>>> hgnc_manager.populate()
Command Line Utility
~~~~~~~~~~~~~~~~~~~~
.. code-block:: bash
bio2bel_hgnc populate
Citation
--------
Gray KA, Yates B, Seal RL, Wright MW, Bruford EA. genenames.org: the HGNC resources in 2015. Nucleic Acids Res. 2015
Expand Down Expand Up @@ -38,9 +72,22 @@ Acknowledgements
:target: https://codecov.io/gh/bio2bel/hgnc?branch=master
:alt: Coverage Status

.. |docs| image:: http://readthedocs.org/projects/bio2bel-hgnc/badge/?version=latest
.. |documentation| image:: http://readthedocs.org/projects/bio2bel-hgnc/badge/?version=latest
:target: http://bio2bel.readthedocs.io/projects/hgnc/en/latest/?badge=latest
:alt: Documentation Status

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

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

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

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

.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1162644.svg
:target: https://doi.org/10.5281/zenodo.1162644

0 comments on commit 435963b

Please sign in to comment.