././@PaxHeader 0000000 0000000 0000000 00000000034 00000000000 010212 x ustar 00 28 mtime=1723255958.9899666 bioregistry-0.11.12/ 0000755 0001751 0000177 00000000000 14655546227 013643 5 ustar 00runner docker ././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1723253894.0 bioregistry-0.11.12/LICENSE 0000644 0001751 0000177 00000002071 14655542206 014641 0 ustar 00runner docker MIT License Copyright (c) 2020-2023 Charles Tapley Hoyt Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1723253894.0 bioregistry-0.11.12/MANIFEST.in 0000644 0001751 0000177 00000001217 14655542206 015373 0 ustar 00runner docker graft src graft tests recursive-include docs *.py recursive-include docs *.rst recursive-include docs *.tsv recursive-include docs Makefile recursive-include docs *.png recursive-include docs *.svg recursive-exclude docs/img *.png global-exclude *.py[cod] __pycache__ *.so *.dylib .DS_Store *.gpickle prune docs/build prune docs/_data prune docs/source/api prune exports prune notebooks prune tests/.pytest_cache exclude docs/*.md exclude docs/guides/*.md exclude docs/_config.yml exclude .appveyor.yml .bumpversion.cfg .coveragerc .flake8 .travis.yml .readthedocs.yml tox.ini .pre-commit-config.yaml Dockerfile CITATION.cff include LICENSE *.md *.rst ././@PaxHeader 0000000 0000000 0000000 00000000034 00000000000 010212 x ustar 00 28 mtime=1723255958.9899666 bioregistry-0.11.12/PKG-INFO 0000644 0001751 0000177 00000101731 14655546227 014743 0 ustar 00runner docker Metadata-Version: 2.1 Name: bioregistry Version: 0.11.12 Summary: Integrated registry of biological databases and nomenclatures Home-page: https://github.com/biopragmatics/bioregistry Download-URL: https://github.com/biopragmatics/bioregistry/releases Author: Charles Tapley Hoyt Author-email: cthoyt@gmail.com Maintainer: Charles Tapley Hoyt Maintainer-email: cthoyt@gmail.com License: MIT Project-URL: Bug Tracker, https://github.com/biopragmatics/bioregistry/issues Keywords: databases,biological databases,biomedical databases Classifier: Development Status :: 4 - Beta Classifier: Environment :: Console Classifier: License :: OSI Approved :: MIT License Classifier: Operating System :: OS Independent Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 Classifier: Programming Language :: Python :: 3.10 Classifier: Programming Language :: Python :: 3.11 Classifier: Programming Language :: Python :: 3.12 Classifier: Programming Language :: Python :: 3 :: Only Requires-Python: >=3.8 Description-Content-Type: text/markdown License-File: LICENSE Requires-Dist: requests Requires-Dist: tqdm Requires-Dist: pystow>=0.1.13 Requires-Dist: click Requires-Dist: more_click>=0.1.2 Requires-Dist: pydantic Requires-Dist: curies>=0.7.0 Provides-Extra: tests Requires-Dist: coverage; extra == "tests" Requires-Dist: pytest; extra == "tests" Requires-Dist: more_itertools; extra == "tests" Requires-Dist: httpx; extra == "tests" Provides-Extra: docs Requires-Dist: sphinx<7.3; extra == "docs" Requires-Dist: sphinx-rtd-theme; extra == "docs" Requires-Dist: sphinx-click; extra == "docs" Requires-Dist: sphinx_automodapi; extra == "docs" Requires-Dist: autodoc_pydantic; extra == "docs" Provides-Extra: gha Requires-Dist: more_itertools; extra == "gha" Provides-Extra: align Requires-Dist: pyyaml; extra == "align" Requires-Dist: beautifulsoup4; extra == "align" Requires-Dist: tabulate; extra == "align" Requires-Dist: defusedxml; extra == "align" Requires-Dist: class-resolver; extra == "align" Requires-Dist: fairsharing-client>=0.1.0; extra == "align" Requires-Dist: pandas; extra == "align" Provides-Extra: export Requires-Dist: pyyaml; extra == "export" Requires-Dist: rdflib; extra == "export" Requires-Dist: rdflib-jsonld; extra == "export" Requires-Dist: ndex2; extra == "export" Provides-Extra: charts Requires-Dist: matplotlib; extra == "charts" Requires-Dist: matplotlib_venn; extra == "charts" Requires-Dist: seaborn; extra == "charts" Requires-Dist: pandas; extra == "charts" Requires-Dist: jinja2; extra == "charts" Provides-Extra: health Requires-Dist: click_default_group; extra == "health" Requires-Dist: pandas; extra == "health" Requires-Dist: tabulate; extra == "health" Requires-Dist: pyyaml; extra == "health" Requires-Dist: jinja2; extra == "health" Provides-Extra: web Requires-Dist: pyyaml; extra == "web" Requires-Dist: rdflib; extra == "web" Requires-Dist: rdflib-jsonld; extra == "web" Requires-Dist: rdflib-endpoint; extra == "web" Requires-Dist: flask<2.2.4; extra == "web" Requires-Dist: werkzeug<2.3.0; extra == "web" Requires-Dist: fastapi; extra == "web" Requires-Dist: uvicorn; extra == "web" Requires-Dist: bootstrap-flask<=2.0.0; extra == "web" Requires-Dist: markdown; extra == "web" Requires-Dist: curies[fastapi]; extra == "web"
A community-driven integrative meta-registry of life science databases, ontologies, and other resources.
More information here.
A community-driven integrative meta-registry of life science databases, ontologies, and other resources.
More information here.
``. |
+--------------------------------------+----------------------------------------------------------+
| ``METAREGISTRY_FOOTER`` | The footer text that appears on all pages. Can include |
| | arbitrary HTML. |
+--------------------------------------+----------------------------------------------------------+
| ``METAREGISTRY_RESOURCES_SUBHEADER`` | The second paragraph on https://bioregistry.io/registry. |
+--------------------------------------+----------------------------------------------------------+
| ``METAREGISTRY_VERSION`` | The version to display in the top-right of each page. |
| | Can be set to an empty string if no meaningful version |
| | information exists. |
+--------------------------------------+----------------------------------------------------------+
| ``METAREGISTRY_EXAMPLE_PREFIX`` | An example prefix. Defaults to ``chebi``. |
+--------------------------------------+----------------------------------------------------------+
| ``METAREGISTRY_EXAMPLE_IDENTIFIER`` | An example local unique identifier to go with the |
| | example prefix |
+--------------------------------------+----------------------------------------------------------+
Finally, after filling up a configuration JSON file and naming it something like ``config.json``,
you can use the ``--config config.json`` flag in the Python commands to run the web service below.
Running in the command line with Python
---------------------------------------
The Bioregistry can be run from the Python shell directly following installation
from the Python Package Index. This example assumes ``registry.json``
is in the same directory, but any valid paths can be given.
.. code-block:: shell
python -m pip install gunicorn bioregistry[web]
python -m bioregistry web \
--with-gunicorn --workers 4 \
--port 8766 \
--host "0.0.0.0" \
--base-url https://example.com \
--registry registry.json
.. note:: This is the same as deploying the vanilla Bioregistry except the usage of ``--registry registry.json``
Running with Docker
-------------------
Create the following ``Dockerfile`` in the same directory as your ``registry.json``, ``config.json``,
and any other custom files.
.. code-block:: docker
# Dockerfile
FROM python:3.11-alpine
COPY registry.json
COPY config.json
RUN python -m pip install gunicorn bioregistry[web]
ENTRYPOINT python -m bioregistry web \
---with-gunicorn --workers 4 \
--port 8766 \
--host "0.0.0.0" \
--base-url https://example.com \
--registry registry.json \
--config config.json
There are two options for running the ``Dockerfile``. The first option
is by running the following two commands in the command line:
.. code-block:: shell
# Build the docker image from the same directory as the Dockerfile
docker build --tag bioregistry_custom:latest .
# Run the docker image, -d means "detach"
docker run -d -p 8766:8766 bioregistry_custom:latest
The second option is to use an additional `Docker compose