=============================================
Cell Maps ImmunoFluorescent Image Downloader
=============================================
.. image:: https://img.shields.io/pypi/v/cellmaps_imagedownloader.svg
:target: https://pypi.python.org/pypi/cellmaps_imagedownloader
.. image:: https://app.travis-ci.com/idekerlab/cellmaps_imagedownloader.svg?branch=main
:target: https://app.travis-ci.com/idekerlab/cellmaps_imagedownloader
.. image:: https://readthedocs.org/projects/cellmaps-imagedownloader/badge/?version=latest
:target: https://cellmaps-imagedownloader.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://zenodo.org/badge/635992073.svg
:target: https://zenodo.org/doi/10.5281/zenodo.10607371
:alt: Zenodo DOI badge
Downloads ImmunoFluorescent image data from `Human Protein Atlas <https://www.proteinatlas.org/>`__
* Free software: MIT license
* Documentation: https://cellmaps-imagedownloader.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::
pip install cellmaps_imagedownloader
**Or directly from source:**
.. code-block::
git clone https://github.com/idekerlab/cellmaps_imagedownloader
cd cellmaps_imagedownloader
make dist
pip install dist/cellmaps_imagedownloader*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
------------
* samples file: CSV file with list of IF images to download (see sample samples file in examples folder)
* unique file: CSV file of unique samples (see sample unique file in examples folder)
* provenance: file containing provenance information about input files in JSON format (see sample provenance file in examples folder)
Usage
-----
For information invoke :code:`cellmaps_imagedownloadercmd.py -h`
**Example usage**
.. code-block::
cellmaps_imagedownloadercmd.py ./cellmaps_imagedownloader_outdir --samples examples/samples.csv --unique examples/unique.csv --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.1 (2024-08-26)
------------------
* Bug fix in adding gene node attributes. The bug was resulting in duplicate entries and
missing gene names, related to ambiguous antibodies.
0.1.0 (2024-01-01)
------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/idekerlab/cellmaps_imagedownloader",
"name": "cellmaps-imagedownloader",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "cellmaps_imagedownloader",
"author": "Cell Maps team",
"author_email": "tools@cm4ai.org",
"download_url": "https://files.pythonhosted.org/packages/95/bb/74e09817beb35994cd97dc289ea53c66ab4cdb87bdbb34f8973767c3725d/cellmaps_imagedownloader-0.1.1.tar.gz",
"platform": null,
"description": "=============================================\nCell Maps ImmunoFluorescent Image Downloader\n=============================================\n\n\n.. image:: https://img.shields.io/pypi/v/cellmaps_imagedownloader.svg\n :target: https://pypi.python.org/pypi/cellmaps_imagedownloader\n\n.. image:: https://app.travis-ci.com/idekerlab/cellmaps_imagedownloader.svg?branch=main\n :target: https://app.travis-ci.com/idekerlab/cellmaps_imagedownloader\n\n.. image:: https://readthedocs.org/projects/cellmaps-imagedownloader/badge/?version=latest\n :target: https://cellmaps-imagedownloader.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://zenodo.org/badge/635992073.svg\n :target: https://zenodo.org/doi/10.5281/zenodo.10607371\n :alt: Zenodo DOI badge\n\n\nDownloads ImmunoFluorescent image data from `Human Protein Atlas <https://www.proteinatlas.org/>`__\n\n\n* Free software: MIT license\n* Documentation: https://cellmaps-imagedownloader.readthedocs.io.\n\n\nDependencies\n------------\n\n* `cellmaps_utils <https://pypi.org/project/cellmaps-utils>`__\n* `requests <https://pypi.org/project/requests>`__\n* `mygene <https://pypi.org/project/mygene>`__\n* `tqdm <https://pypi.org/project/tqdm>`__\n\nCompatibility\n-------------\n\n* Python 3.8+\n\nInstallation\n------------\n\n.. code-block::\n\n pip install cellmaps_imagedownloader\n\n**Or directly from source:**\n\n.. code-block::\n\n git clone https://github.com/idekerlab/cellmaps_imagedownloader\n cd cellmaps_imagedownloader\n make dist\n pip install dist/cellmaps_imagedownloader*whl\n\n\nRun **make** command with no arguments to see other build/deploy options including creation of Docker image \n\n.. code-block::\n\n make\n\nOutput:\n\n.. code-block::\n\n clean remove all build, test, coverage and Python artifacts\n clean-build remove build artifacts\n clean-pyc remove Python file artifacts\n clean-test remove test and coverage artifacts\n lint check style with flake8\n test run tests quickly with the default Python\n test-all run tests on every Python version with tox\n coverage check code coverage quickly with the default Python\n docs generate Sphinx HTML documentation, including API docs\n servedocs compile the docs watching for changes\n testrelease package and upload a TEST release\n release package and upload a release\n dist builds source and wheel package\n install install the package to the active Python's site-packages\n dockerbuild build docker image and store in local repository\n dockerpush push image to dockerhub\n\n\n\n\nNeeded files\n------------\n\n* samples file: CSV file with list of IF images to download (see sample samples file in examples folder)\n* unique file: CSV file of unique samples (see sample unique file in examples folder)\n* provenance: file containing provenance information about input files in JSON format (see sample provenance file in examples folder)\n\nUsage\n-----\n\nFor information invoke :code:`cellmaps_imagedownloadercmd.py -h`\n\n**Example usage**\n\n\n.. code-block::\n\n cellmaps_imagedownloadercmd.py ./cellmaps_imagedownloader_outdir --samples examples/samples.csv --unique examples/unique.csv --provenance examples/provenance.json\n\n\nVia Docker\n~~~~~~~~~~~~~~~~~~~~~~\n\n**Example usage**\n\n\n.. code-block::\n\n Coming soon...\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n.. _NDEx: http://www.ndexbio.org\n\n\n=======\nHistory\n=======\n\n0.1.1 (2024-08-26)\n------------------\n\n* Bug fix in adding gene node attributes. The bug was resulting in duplicate entries and\n missing gene names, related to ambiguous antibodies.\n\n0.1.0 (2024-01-01)\n------------------\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "A tool to download specified image data from the Human Protein Atlas website using CSV file or to copy data from CM4AI dataset",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/idekerlab/cellmaps_imagedownloader"
},
"split_keywords": [
"cellmaps_imagedownloader"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b9e2d55c291ee59f0fc519d51dc7a8e0588b2193cde06b70a96b12d3f69fbf5e",
"md5": "e91075d74d785b1ab1d2b76bed9677db",
"sha256": "3d5d3cf2e712a534c948781a0f8b7f8ff8d80e7c79605e2c18ff728c11d1c15b"
},
"downloads": -1,
"filename": "cellmaps_imagedownloader-0.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e91075d74d785b1ab1d2b76bed9677db",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 29776,
"upload_time": "2024-08-26T17:09:42",
"upload_time_iso_8601": "2024-08-26T17:09:42.058140Z",
"url": "https://files.pythonhosted.org/packages/b9/e2/d55c291ee59f0fc519d51dc7a8e0588b2193cde06b70a96b12d3f69fbf5e/cellmaps_imagedownloader-0.1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95bb74e09817beb35994cd97dc289ea53c66ab4cdb87bdbb34f8973767c3725d",
"md5": "b14676a21f2f6abdc9f15a25832036fb",
"sha256": "7403b1ff01691b21b7dbeaa3f598dad6eb245aa2e3af12de7355118d50340504"
},
"downloads": -1,
"filename": "cellmaps_imagedownloader-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "b14676a21f2f6abdc9f15a25832036fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 112591,
"upload_time": "2024-08-26T17:09:43",
"upload_time_iso_8601": "2024-08-26T17:09:43.240667Z",
"url": "https://files.pythonhosted.org/packages/95/bb/74e09817beb35994cd97dc289ea53c66ab4cdb87bdbb34f8973767c3725d/cellmaps_imagedownloader-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-26 17:09:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "idekerlab",
"github_project": "cellmaps_imagedownloader",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "cellmaps-imagedownloader"
}
JSON
