idekerlab / cellmaps_utils

MIT License
1 stars 0 forks source link

============================= Cell Maps Pipeline Utilities

.. image:: https://img.shields.io/pypi/v/cellmaps_utils.svg :target: https://pypi.python.org/pypi/cellmaps_utils

.. image:: https://app.travis-ci.com/idekerlab/cellmaps_utils.svg?branch=main :target: https://app.travis-ci.com/idekerlab/cellmaps_utils

.. image:: https://readthedocs.org/projects/cellmaps-utils/badge/?version=latest :target: https://cellmaps-utils.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

.. image:: https://zenodo.org/badge/599754117.svg :target: https://zenodo.org/doi/10.5281/zenodo.10607322 :alt: Zenodo DOI badge

Contains utilities needed by various tools in the cell maps toolkit.

Dependencies

Compatibility

Installation

.. code-block::

git clone https://github.com/idekerlab/cellmaps_utils cd cellmaps_utils make dist pip install dist/cellmaps_utils*whl

Run make command with no arguments to see other build/deploy options including creation of Docker image

.. code-block::

make

Output:

.. code-block::

clean remove all build, test, coverage and Python artifacts clean-build remove build artifacts clean-pyc remove Python file artifacts clean-test remove test and coverage artifacts lint check style with flake8 test run tests quickly with the default Python test-all run tests on every Python version with tox coverage check code coverage quickly with the default Python docs generate Sphinx HTML documentation, including API docs servedocs compile the docs watching for changes testrelease package and upload a TEST release release package and upload a release dist builds source and wheel package install install the package to the active Python's site-packages

Before running tests, please install pip install -r requirements_dev

For developers

To deploy development versions of this package



Below are steps to make changes to this code base, deploy, and then run
against those changes.

#. Make changes

Modify code in this repo as desired

#. Build and deploy

.. code-block::

    # From base directory of this repo cellmaps_hierarchyeval
    pip uninstall cellmaps_utils -y ; make clean dist; pip install dist/cellmaps_utils*whl

Credits
-------

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
.. _NDEx: http://www.ndexbio.org