<!--
<p align="center">
<img src="https://github.com/cthoyt/fairsharing-client/raw/main/docs/source/logo.png" height="150">
</p>
-->
<h1 align="center">
FAIRsharing Client
</h1>
<p align="center">
<a href="https://github.com/cthoyt/fairsharing-client/actions?query=workflow%3ATests">
<img alt="Tests" src="https://github.com/cthoyt/fairsharing-client/workflows/Tests/badge.svg" />
</a>
<a href="https://pypi.org/project/fairsharing_client">
<img alt="PyPI" src="https://img.shields.io/pypi/v/fairsharing_client" />
</a>
<a href="https://pypi.org/project/fairsharing_client">
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/fairsharing_client" />
</a>
<a href="https://github.com/cthoyt/fairsharing-client/blob/main/LICENSE">
<img alt="PyPI - License" src="https://img.shields.io/pypi/l/fairsharing_client" />
</a>
<a href='https://fairsharing-client.readthedocs.io/en/latest/?badge=latest'>
<img src='https://readthedocs.org/projects/fairsharing-client/badge/?version=latest' alt='Documentation Status' />
</a>
<a href="https://codecov.io/gh/cthoyt/fairsharing-client/branch/main">
<img src="https://codecov.io/gh/cthoyt/fairsharing-client/branch/main/graph/badge.svg" alt="Codecov status" />
</a>
<a href="https://github.com/cthoyt/cookiecutter-python-package">
<img alt="Cookiecutter template from @cthoyt" src="https://img.shields.io/badge/Cookiecutter-snekpack-blue" />
</a>
<a href='https://github.com/psf/black'>
<img src='https://img.shields.io/badge/code%20style-black-000000.svg' alt='Code style: black' />
</a>
<a href="https://github.com/cthoyt/fairsharing-client/blob/main/.github/CODE_OF_CONDUCT.md">
<img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg" alt="Contributor Covenant"/>
</a>
</p>
A client to the [FAIRsharing API](https://beta.fairsharing.org/API_doc).
## 💪 Getting Started
FAIRsharing is a registry of high-quality metadata about standards, databases,
and policies. However, there are two aspects to FAIRsharing's data that make it
difficult to use:
1. It's licensed under the restrictive [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) license (
see https://fairsharing.org/licence). This makes it difficult to redistribute
the data, even in part. Better options for community reuse are [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/) or
ideally [CC0](https://creativecommons.org/share-your-work/public-domain/cc0/). However, keep in mind that FAIR and Open are emphatically
[not the same thing](https://www.go-fair.org/resources/faq/ask-question-difference-fair-data-open-data/).
2. Instead of offering a bulk download, there is an API that requires
authentication using [JWT](https://jwt.io).
While there's nothing wrong with JWT, it requires several steps that make
programmatic access inconvenient for less seasoned programmers.
The `fairsharing_client` package provides a way to automatically bulk download
all contents from the API and store them locally in a reproducible way, so you
can write code that relies on FAIRsharing data without having to worry about how
to interact with its API nor redistribute its data yourself. Further,
this package does some preprocessing on the content to make it more useful.
```python
import fairsharing_client as fc
# Download the data and return the path of the YAML file
# This takes about 4 minutes and gets around 4K records.
path = fc.ensure_fairsharing()
# Download the data and open it for use
data = fc.load_fairsharing()
# Get data for a given record
chebi_record = data["FAIRsharing.62qk8w"]
```
There are a few ways to do authentication:
1. **Envionment Variables**: set the `FAIRSHARING_LOGIN`
and `FAIRSHARING_PASSWORD` envionrment variables
2. **Configuration**: in the `~/.config/fairshairing.ini` file, add the
following configuration:
```ini
[fairsharing]
login = cthoyt@gmail.com
password = ...
```
3. **Keyword arguments**: pass the `login` and `password` keywords to either of
the example functions.
A reminder: this repository does NOT redistribute FAIRsharing's data, it only
provides code for you to get it yourself.
## 🚀 Installation
The most recent release can be installed from
[PyPI](https://pypi.org/project/fairsharing_client/) with:
```bash
$ pip install fairsharing_client
```
The most recent code and data can be installed directly from GitHub with:
```bash
$ pip install git+https://github.com/cthoyt/fairsharing-client.git
```
## 👐 Contributing
Contributions, whether filing an issue, making a pull request, or forking, are
appreciated. See
[CONTRIBUTING.md](https://github.com/cthoyt/fairsharing-client/blob/master/.github/CONTRIBUTING.md)
for more information on getting involved.
## 👋 Attribution
### ⚖️ License
The code in this package is licensed under the MIT License.
### 🍪 Cookiecutter
This package was created
with [@audreyfeldroy](https://github.com/audreyfeldroy)'s
[cookiecutter](https://github.com/cookiecutter/cookiecutter) package
using [@cthoyt](https://github.com/cthoyt)'s
[cookiecutter-snekpack](https://github.com/cthoyt/cookiecutter-snekpack)
template.
## 🛠️ For Developers
<details>
<summary>See developer instructions</summary>
The final section of the README is for if you want to get involved by making a
code contribution.
### Development Installation
To install in development mode, use the following:
```bash
$ git clone git+https://github.com/cthoyt/fairsharing-client.git
$ cd fairsharing-client
$ pip install -e .
```
### 🥼 Testing
After cloning the repository and installing `tox` with `pip install tox`, the
unit tests in the `tests/` folder can be run reproducibly with:
```shell
$ tox
```
Additionally, these tests are automatically re-run with each commit in
a [GitHub Action](https://github.com/cthoyt/fairsharing-client/actions?query=workflow%3ATests)
.
### 📖 Building the Documentation
The documentation can be built locally using the following:
```shell
$ git clone git+https://github.com/cthoyt/fairsharing-client.git
$ cd fairsharing-client
$ tox -e docs
$ open docs/build/html/index.html
```
The documentation automatically installs the package as well as the `docs`
extra specified in the [`setup.cfg`](setup.cfg). `sphinx` plugins like `texext`
can be added there. Additionally, they need to be added to the
`extensions` list in [`docs/source/conf.py`](docs/source/conf.py).
### 📦 Making a Release
After installing the package in development mode and installing
`tox` with `pip install tox`, the commands for making a new release are
contained within the `finish` environment in `tox.ini`. Run the following from
the shell:
```shell
$ tox -e finish
```
This script does the following:
1. Uses [Bump2Version](https://github.com/c4urself/bump2version) to switch the
version number in the `setup.cfg`,
`src/fairsharing_client/version.py`,
and [`docs/source/conf.py`](docs/source/conf.py) to not have the `-dev`
suffix
2. Packages the code in both a tar archive and a wheel
using [`build`](https://github.com/pypa/build)
3. Uploads to PyPI using [`twine`](https://github.com/pypa/twine). Be sure to
have a `.pypirc` file configured to avoid the need for manual input at this
step
4. Push to GitHub. You'll need to make a release going with the commit where the
version was bumped.
5. Bump the version to the next patch. If you made big changes and want to bump
the version by minor, you can use `tox -e bumpversion minor` after.
</details>
Raw data
{
"_id": null,
"home_page": "https://github.com/cthoyt/fairsharing-client",
"name": "fairsharing-client",
"maintainer": "Charles Tapley Hoyt",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "cthoyt@gmail.com",
"keywords": "snekpack,cookiecutter,FAIRsharing",
"author": "Charles Tapley Hoyt",
"author_email": "cthoyt@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f4/a3/cb7260829c960b130a2c893cb8dccd2bab3c31518b778541c7e79aee0189/fairsharing_client-0.1.0.tar.gz",
"platform": null,
"description": "<!--\n<p align=\"center\">\n <img src=\"https://github.com/cthoyt/fairsharing-client/raw/main/docs/source/logo.png\" height=\"150\">\n</p>\n-->\n\n<h1 align=\"center\">\n FAIRsharing Client\n</h1>\n\n<p align=\"center\">\n <a href=\"https://github.com/cthoyt/fairsharing-client/actions?query=workflow%3ATests\">\n <img alt=\"Tests\" src=\"https://github.com/cthoyt/fairsharing-client/workflows/Tests/badge.svg\" />\n </a>\n <a href=\"https://pypi.org/project/fairsharing_client\">\n <img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/fairsharing_client\" />\n </a>\n <a href=\"https://pypi.org/project/fairsharing_client\">\n <img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/fairsharing_client\" />\n </a>\n <a href=\"https://github.com/cthoyt/fairsharing-client/blob/main/LICENSE\">\n <img alt=\"PyPI - License\" src=\"https://img.shields.io/pypi/l/fairsharing_client\" />\n </a>\n <a href='https://fairsharing-client.readthedocs.io/en/latest/?badge=latest'>\n <img src='https://readthedocs.org/projects/fairsharing-client/badge/?version=latest' alt='Documentation Status' />\n </a>\n <a href=\"https://codecov.io/gh/cthoyt/fairsharing-client/branch/main\">\n <img src=\"https://codecov.io/gh/cthoyt/fairsharing-client/branch/main/graph/badge.svg\" alt=\"Codecov status\" />\n </a> \n <a href=\"https://github.com/cthoyt/cookiecutter-python-package\">\n <img alt=\"Cookiecutter template from @cthoyt\" src=\"https://img.shields.io/badge/Cookiecutter-snekpack-blue\" /> \n </a>\n <a href='https://github.com/psf/black'>\n <img src='https://img.shields.io/badge/code%20style-black-000000.svg' alt='Code style: black' />\n </a>\n <a href=\"https://github.com/cthoyt/fairsharing-client/blob/main/.github/CODE_OF_CONDUCT.md\">\n <img src=\"https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg\" alt=\"Contributor Covenant\"/>\n </a>\n</p>\n\nA client to the [FAIRsharing API](https://beta.fairsharing.org/API_doc).\n\n## \ud83d\udcaa Getting Started\n\nFAIRsharing is a registry of high-quality metadata about standards, databases,\nand policies. However, there are two aspects to FAIRsharing's data that make it\ndifficult to use:\n\n1. It's licensed under the restrictive [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) license (\n see https://fairsharing.org/licence). This makes it difficult to redistribute\n the data, even in part. Better options for community reuse are [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/) or\n ideally [CC0](https://creativecommons.org/share-your-work/public-domain/cc0/). However, keep in mind that FAIR and Open are emphatically\n [not the same thing](https://www.go-fair.org/resources/faq/ask-question-difference-fair-data-open-data/).\n2. Instead of offering a bulk download, there is an API that requires\n authentication using [JWT](https://jwt.io).\n\nWhile there's nothing wrong with JWT, it requires several steps that make\nprogrammatic access inconvenient for less seasoned programmers.\nThe `fairsharing_client` package provides a way to automatically bulk download\nall contents from the API and store them locally in a reproducible way, so you\ncan write code that relies on FAIRsharing data without having to worry about how\nto interact with its API nor redistribute its data yourself. Further,\nthis package does some preprocessing on the content to make it more useful.\n\n```python\nimport fairsharing_client as fc\n\n# Download the data and return the path of the YAML file\n# This takes about 4 minutes and gets around 4K records.\npath = fc.ensure_fairsharing()\n\n# Download the data and open it for use\ndata = fc.load_fairsharing() \n\n# Get data for a given record\nchebi_record = data[\"FAIRsharing.62qk8w\"]\n```\n\nThere are a few ways to do authentication:\n\n1. **Envionment Variables**: set the `FAIRSHARING_LOGIN`\n and `FAIRSHARING_PASSWORD` envionrment variables\n2. **Configuration**: in the `~/.config/fairshairing.ini` file, add the\n following configuration:\n ```ini\n [fairsharing]\n login = cthoyt@gmail.com\n password = ...\n ```\n3. **Keyword arguments**: pass the `login` and `password` keywords to either of\n the example functions.\n\nA reminder: this repository does NOT redistribute FAIRsharing's data, it only\nprovides code for you to get it yourself.\n\n## \ud83d\ude80 Installation\n\nThe most recent release can be installed from\n[PyPI](https://pypi.org/project/fairsharing_client/) with:\n\n```bash\n$ pip install fairsharing_client\n```\n\nThe most recent code and data can be installed directly from GitHub with:\n\n```bash\n$ pip install git+https://github.com/cthoyt/fairsharing-client.git\n```\n\n## \ud83d\udc50 Contributing\n\nContributions, whether filing an issue, making a pull request, or forking, are\nappreciated. See\n[CONTRIBUTING.md](https://github.com/cthoyt/fairsharing-client/blob/master/.github/CONTRIBUTING.md)\nfor more information on getting involved.\n\n## \ud83d\udc4b Attribution\n\n### \u2696\ufe0f License\n\nThe code in this package is licensed under the MIT License.\n\n### \ud83c\udf6a Cookiecutter\n\nThis package was created\nwith [@audreyfeldroy](https://github.com/audreyfeldroy)'s\n[cookiecutter](https://github.com/cookiecutter/cookiecutter) package\nusing [@cthoyt](https://github.com/cthoyt)'s\n[cookiecutter-snekpack](https://github.com/cthoyt/cookiecutter-snekpack)\ntemplate.\n\n## \ud83d\udee0\ufe0f For Developers\n\n<details>\n <summary>See developer instructions</summary>\n\n\nThe final section of the README is for if you want to get involved by making a\ncode contribution.\n\n### Development Installation\n\nTo install in development mode, use the following:\n\n```bash\n$ git clone git+https://github.com/cthoyt/fairsharing-client.git\n$ cd fairsharing-client\n$ pip install -e .\n```\n\n### \ud83e\udd7c Testing\n\nAfter cloning the repository and installing `tox` with `pip install tox`, the\nunit tests in the `tests/` folder can be run reproducibly with:\n\n```shell\n$ tox\n```\n\nAdditionally, these tests are automatically re-run with each commit in\na [GitHub Action](https://github.com/cthoyt/fairsharing-client/actions?query=workflow%3ATests)\n.\n\n### \ud83d\udcd6 Building the Documentation\n\nThe documentation can be built locally using the following:\n\n```shell\n$ git clone git+https://github.com/cthoyt/fairsharing-client.git\n$ cd fairsharing-client\n$ tox -e docs\n$ open docs/build/html/index.html\n``` \n\nThe documentation automatically installs the package as well as the `docs`\nextra specified in the [`setup.cfg`](setup.cfg). `sphinx` plugins like `texext`\ncan be added there. Additionally, they need to be added to the\n`extensions` list in [`docs/source/conf.py`](docs/source/conf.py).\n\n### \ud83d\udce6 Making a Release\n\nAfter installing the package in development mode and installing\n`tox` with `pip install tox`, the commands for making a new release are\ncontained within the `finish` environment in `tox.ini`. Run the following from\nthe shell:\n\n```shell\n$ tox -e finish\n```\n\nThis script does the following:\n\n1. Uses [Bump2Version](https://github.com/c4urself/bump2version) to switch the\n version number in the `setup.cfg`,\n `src/fairsharing_client/version.py`,\n and [`docs/source/conf.py`](docs/source/conf.py) to not have the `-dev`\n suffix\n2. Packages the code in both a tar archive and a wheel\n using [`build`](https://github.com/pypa/build)\n3. Uploads to PyPI using [`twine`](https://github.com/pypa/twine). Be sure to\n have a `.pypirc` file configured to avoid the need for manual input at this\n step\n4. Push to GitHub. You'll need to make a release going with the commit where the\n version was bumped.\n5. Bump the version to the next patch. If you made big changes and want to bump\n the version by minor, you can use `tox -e bumpversion minor` after.\n\n</details>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A client to the FAIRsharing API",
"version": "0.1.0",
"split_keywords": [
"snekpack",
"cookiecutter",
"fairsharing"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "c472b3c43eb3eec64d14a43b4539cb92",
"sha256": "3ca0ca70f6e1f6f81ebd4e68d1c59691ea272975f19d8929940e5402cfaa3644"
},
"downloads": -1,
"filename": "fairsharing_client-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c472b3c43eb3eec64d14a43b4539cb92",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9024,
"upload_time": "2022-12-11T15:26:35",
"upload_time_iso_8601": "2022-12-11T15:26:35.820159Z",
"url": "https://files.pythonhosted.org/packages/d8/5e/16060ef7acc75b75b8a0be1d5096ed98154d189d930eba343cb46b48b802/fairsharing_client-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "69c17fc3aace4fdcdda938d803e6f455",
"sha256": "8ee8d74d9677a489a9e757edde9447102839f2f60f6373ff3163029812b19b90"
},
"downloads": -1,
"filename": "fairsharing_client-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "69c17fc3aace4fdcdda938d803e6f455",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 15667,
"upload_time": "2022-12-11T15:26:37",
"upload_time_iso_8601": "2022-12-11T15:26:37.864080Z",
"url": "https://files.pythonhosted.org/packages/f4/a3/cb7260829c960b130a2c893cb8dccd2bab3c31518b778541c7e79aee0189/fairsharing_client-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-11 15:26:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "cthoyt",
"github_project": "fairsharing-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "fairsharing-client"
}
JSON
