Metadata-Version: 2.1
Name: cellmaps-ppidownloader
Version: 0.1.0a8
Summary: A tool to download AP-MS data for Cell Maps pipeline
Home-page: https://github.com/idekerlab/cellmaps_ppidownloader
Author: Ideker Lab Cell Maps team
Author-email: tools@cm4ai.org
License: MIT license
Description: ================================
        Cell Maps for AI PPI Downloader
        ================================
        
        
        .. image:: https://img.shields.io/pypi/v/cellmaps_ppidownloader.svg
                :target: https://pypi.python.org/pypi/cellmaps_ppidownloader
        
        .. image:: https://app.travis-ci.com/idekerlab/cellmaps_ppidownloader.svg?branch=main
            :target: https://app.travis-ci.com/idekerlab/cellmaps_ppidownloader
        
        .. image:: https://readthedocs.org/projects/cellmaps-ppidownloader/badge/?version=latest
                :target: https://cellmaps-ppidownloader.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        
        Downloads protein-protein interaction data
        
        
        * Free software: MIT license
        * Documentation: https://cellmaps-ppidownloader.readthedocs.io.
        
        Dependencies
        ------------
        
        * `cellmaps_utils <https://pypi.org/project/cellmaps-utils>`__
        * `requests <https://pypi.org/project/requests>`__
        * `mygene <https://pypi.org/project/mygene>`__
        * `tqdm <https://pypi.org/project/tqdm>`__
        
        Compatibility
        -------------
        
        * Python 3.8+
        
        Installation
        ------------
        
        .. code-block::
        
           git clone https://github.com/idekerlab/cellmaps_ppidownloader
           cd cellmaps_ppidownloader
           make dist
           pip install dist/cellmaps_ppidownloader*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
           dockerbuild          build docker image and store in local repository
           dockerpush           push image to dockerhub
        
        
        
        
        Needed files
        ------------
        
        * bait list file: TSV file of baits used for AP-MS experiments
        * edge list file: TSV file of edges for protein interaction network
        * provenance: file containing provenance information about input files in JSON format (see sample provenance file in examples folder)
        
        
        Usage
        -----
        
        For information invoke :code:`cellmaps_ppidownloadercmd.py -h`
        
        **Example usage**
        
        .. code-block::
        
           cellmaps_ppidownloadercmd.py ./cellmaps_ppidownloader_outdir --edgelist examples/edgelist.tsv --baitlist examples/baitlist.tsv --provenance examples/provenance.json
        
        
        Via Docker
        ~~~~~~~~~~~~~~~~~~~~~~
        
        **Example usage**
        
        .. code-block::
        
           Coming soon...
        
        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
        
        
        =======
        History
        =======
        
        0.1.0 (2023-05-15)
        ------------------
        
        * First release on PyPI.
        
Keywords: cellmaps_ppidownloader
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/x-rst
