<!--
<p align="center">
<img src="https://github.com/cthoyt/quickstatements-client/raw/main/docs/source/logo.png" height="150">
</p>
-->
<h1 align="center">
QuickStatements Client
</h1>
<p align="center">
<a href="https://github.com/cthoyt/quickstatements_client/actions/workflows/tests.yml">
<img alt="Tests" src="https://github.com/cthoyt/quickstatements_client/actions/workflows/tests.yml/badge.svg" />
</a>
<a href="https://pypi.org/project/quickstatements_client">
<img alt="PyPI" src="https://img.shields.io/pypi/v/quickstatements_client" />
</a>
<a href="https://pypi.org/project/quickstatements_client">
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/quickstatements_client" />
</a>
<a href="https://github.com/cthoyt/quickstatements-client/blob/main/LICENSE">
<img alt="PyPI - License" src="https://img.shields.io/pypi/l/quickstatements_client" />
</a>
<a href='https://quickstatements-client.readthedocs.io/en/latest/?badge=latest'>
<img src='https://readthedocs.org/projects/quickstatements-client/badge/?version=latest' alt='Documentation Status' />
</a>
<a href="https://codecov.io/gh/cthoyt/quickstatements-client/branch/main">
<img src="https://codecov.io/gh/cthoyt/quickstatements-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/quickstatements-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>
<a href="https://zenodo.org/badge/latestdoi/606491168">
<img src="https://zenodo.org/badge/606491168.svg" alt="DOI">
</a>
</p>
A data model and client for Wikidata [QuickStatements](https://quickstatements.toolforge.org).
## 💪 Getting Started
Here's how to quickly construct some QuickStatements
```python
import datetime
from quickstatements_client import DateQualifier, EntityQualifier, TextQualifier, EntityLine
subject_qid = "Q47475003" # Charles Tapley Hoyt
subject_orcid = "0000-0003-4423-4370"
reference_url_qualifier = TextQualifier(
predicate="S854", target=f"https://orcid.org/0000-0003-4423-4370"
)
start_date = datetime.datetime(year=2021, day=15, month=2)
start_date_qualifier = DateQualifier.start_time(start_date)
position_held_qualifier = EntityQualifier(predicate="P39", target="Q1706722")
employment_line = EntityLine(
subject=subject_qid,
predicate="P108", # employer
target="Q49121", # Harvard medical school
qualifiers=[reference_url_qualifier, start_date_qualifier, position_held_qualifier],
)
>>> employment_line.get_line()
'Q47475003|P108|Q49121|S854|"https://orcid.org/0000-0003-4423-4370"|P580|+2021-02-15T00:00:00Z/11|P39|Q1706722',
```
How to send some QuickStatements to the API:
```python
from quickstatements_client import QuickStatementsClient
lines = [
employment_line,
...
]
client = QuickStatementsClient(token=..., username=...)
res = client.post(lines, batch_name="Test Batch")
# see also res.batch_id
import webbrowser
webbrowser.open_new_tab(res.batch_url)
```
Note: `token` and `username` are automatically looked up with `pystow` if they aren't given.
Specifically, using `pystow.get_config("quickstatements", "token)` and
`pystow.get_config("quickstatements", "username")`.
## 🚀 Installation
The most recent release can be installed from
[PyPI](https://pypi.org/project/quickstatements_client/) with:
```shell
$ pip install quickstatements_client
```
The most recent code and data can be installed directly from GitHub with:
```bash
$ pip install git+https://github.com/cthoyt/quickstatements-client.git
```
## 👐 Contributing
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See
[CONTRIBUTING.md](https://github.com/cthoyt/quickstatements-client/blob/master/.github/CONTRIBUTING.md) for more information on getting involved.
## 👋 Attribution
This code was originally written as a contribution to [PyORCIDator](https://github.com/lubianat/pyorcidator).
Special thanks to Tiago Lubiana [@lubianat] and João Vitor [@jvfe] for discussions and testing.
### ⚖️ License
The code in this package is licensed under the MIT License.
<!--
### 📖 Citation
Citation goes here!
-->
<!--
### 🎁 Support
This project has been supported by the following organizations (in alphabetical order):
- [Harvard Program in Therapeutic Science - Laboratory of Systems Pharmacology](https://hits.harvard.edu/the-program/laboratory-of-systems-pharmacology/)
-->
<!--
### 💰 Funding
This project has been supported by the following grants:
| Funding Body | Program | Grant |
|----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|-----------------|
| DARPA | [Automating Scientific Knowledge Extraction (ASKE)](https://www.darpa.mil/program/automating-scientific-knowledge-extraction) | HR00111990009 |
-->
### 🍪 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/quickstatements-client.git
$ cd quickstatements-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/quickstatements-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/quickstatements-client.git
$ cd quickstatements-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/quickstatements_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/quickstatements_client",
"name": "quickstatements-client",
"maintainer": "Charles Tapley Hoyt",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "cthoyt@gmail.com",
"keywords": "snekpack, cookiecutter, wikidata, quickstatements, pydantic",
"author": "Charles Tapley Hoyt",
"author_email": "cthoyt@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c5/b7/fc1855217a266918701e60d9df388b51eecebd3c7d5bf7a709846860891d/quickstatements_client-0.0.6.tar.gz",
"platform": null,
"description": "<!--\n<p align=\"center\">\n <img src=\"https://github.com/cthoyt/quickstatements-client/raw/main/docs/source/logo.png\" height=\"150\">\n</p>\n-->\n\n<h1 align=\"center\">\n QuickStatements Client\n</h1>\n\n<p align=\"center\">\n <a href=\"https://github.com/cthoyt/quickstatements_client/actions/workflows/tests.yml\">\n <img alt=\"Tests\" src=\"https://github.com/cthoyt/quickstatements_client/actions/workflows/tests.yml/badge.svg\" />\n </a>\n <a href=\"https://pypi.org/project/quickstatements_client\">\n <img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/quickstatements_client\" />\n </a>\n <a href=\"https://pypi.org/project/quickstatements_client\">\n <img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/quickstatements_client\" />\n </a>\n <a href=\"https://github.com/cthoyt/quickstatements-client/blob/main/LICENSE\">\n <img alt=\"PyPI - License\" src=\"https://img.shields.io/pypi/l/quickstatements_client\" />\n </a>\n <a href='https://quickstatements-client.readthedocs.io/en/latest/?badge=latest'>\n <img src='https://readthedocs.org/projects/quickstatements-client/badge/?version=latest' alt='Documentation Status' />\n </a>\n <a href=\"https://codecov.io/gh/cthoyt/quickstatements-client/branch/main\">\n <img src=\"https://codecov.io/gh/cthoyt/quickstatements-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/quickstatements-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 <a href=\"https://zenodo.org/badge/latestdoi/606491168\">\n <img src=\"https://zenodo.org/badge/606491168.svg\" alt=\"DOI\">\n </a>\n</p>\n\nA data model and client for Wikidata [QuickStatements](https://quickstatements.toolforge.org).\n\n## \ud83d\udcaa Getting Started\n\nHere's how to quickly construct some QuickStatements\n\n```python\nimport datetime\nfrom quickstatements_client import DateQualifier, EntityQualifier, TextQualifier, EntityLine\n\nsubject_qid = \"Q47475003\" # Charles Tapley Hoyt\nsubject_orcid = \"0000-0003-4423-4370\"\nreference_url_qualifier = TextQualifier(\n predicate=\"S854\", target=f\"https://orcid.org/0000-0003-4423-4370\"\n)\nstart_date = datetime.datetime(year=2021, day=15, month=2)\nstart_date_qualifier = DateQualifier.start_time(start_date)\nposition_held_qualifier = EntityQualifier(predicate=\"P39\", target=\"Q1706722\")\nemployment_line = EntityLine(\n subject=subject_qid,\n predicate=\"P108\", # employer\n target=\"Q49121\", # Harvard medical school\n qualifiers=[reference_url_qualifier, start_date_qualifier, position_held_qualifier],\n)\n\n>>> employment_line.get_line()\n'Q47475003|P108|Q49121|S854|\"https://orcid.org/0000-0003-4423-4370\"|P580|+2021-02-15T00:00:00Z/11|P39|Q1706722',\n```\n\nHow to send some QuickStatements to the API:\n\n```python\nfrom quickstatements_client import QuickStatementsClient\n\nlines = [\n employment_line,\n ...\n]\n\nclient = QuickStatementsClient(token=..., username=...)\nres = client.post(lines, batch_name=\"Test Batch\")\n# see also res.batch_id\n\nimport webbrowser\nwebbrowser.open_new_tab(res.batch_url)\n```\n\nNote: `token` and `username` are automatically looked up with `pystow` if they aren't given.\nSpecifically, using `pystow.get_config(\"quickstatements\", \"token)` and\n`pystow.get_config(\"quickstatements\", \"username\")`.\n\n\n## \ud83d\ude80 Installation\n\nThe most recent release can be installed from\n[PyPI](https://pypi.org/project/quickstatements_client/) with:\n\n```shell\n$ pip install quickstatements_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/quickstatements-client.git\n```\n\n## \ud83d\udc50 Contributing\n\nContributions, whether filing an issue, making a pull request, or forking, are appreciated. See\n[CONTRIBUTING.md](https://github.com/cthoyt/quickstatements-client/blob/master/.github/CONTRIBUTING.md) for more information on getting involved.\n\n## \ud83d\udc4b Attribution\n\nThis code was originally written as a contribution to [PyORCIDator](https://github.com/lubianat/pyorcidator).\nSpecial thanks to Tiago Lubiana [@lubianat] and Jo\u00e3o Vitor [@jvfe] for discussions and testing.\n\n### \u2696\ufe0f License\n\nThe code in this package is licensed under the MIT License.\n\n<!--\n### \ud83d\udcd6 Citation\n\nCitation goes here!\n-->\n\n<!--\n### \ud83c\udf81 Support\n\nThis project has been supported by the following organizations (in alphabetical order):\n\n- [Harvard Program in Therapeutic Science - Laboratory of Systems Pharmacology](https://hits.harvard.edu/the-program/laboratory-of-systems-pharmacology/)\n\n-->\n\n<!--\n### \ud83d\udcb0 Funding\n\nThis project has been supported by the following grants:\n\n| Funding Body | Program | Grant |\n|----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|-----------------|\n| DARPA | [Automating Scientific Knowledge Extraction (ASKE)](https://www.darpa.mil/program/automating-scientific-knowledge-extraction) | HR00111990009 |\n-->\n\n### \ud83c\udf6a Cookiecutter\n\nThis package was created with [@audreyfeldroy](https://github.com/audreyfeldroy)'s\n[cookiecutter](https://github.com/cookiecutter/cookiecutter) package using [@cthoyt](https://github.com/cthoyt)'s\n[cookiecutter-snekpack](https://github.com/cthoyt/cookiecutter-snekpack) template.\n\n## \ud83d\udee0\ufe0f For Developers\n\n<details>\n <summary>See developer instructions</summary>\n\nThe final section of the README is for if you want to get involved by making a code 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/quickstatements-client.git\n$ cd quickstatements-client\n$ pip install -e .\n```\n\n### \ud83e\udd7c Testing\n\nAfter cloning the repository and installing `tox` with `pip install tox`, the unit tests in the `tests/` folder can be\nrun reproducibly with:\n\n```shell\n$ tox\n```\n\nAdditionally, these tests are automatically re-run with each commit in a [GitHub Action](https://github.com/cthoyt/quickstatements-client/actions?query=workflow%3ATests).\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/quickstatements-client.git\n$ cd quickstatements-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\nlike `texext` can 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 contained within the `finish` environment\nin `tox.ini`. Run the following from the 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 version number in the `setup.cfg`,\n `src/quickstatements_client/version.py`, and [`docs/source/conf.py`](docs/source/conf.py) to not have the `-dev` suffix\n2. Packages the code in both a tar archive and a wheel using [`build`](https://github.com/pypa/build)\n3. 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\n step\n4. Push to GitHub. You'll need to make a release going with the commit where the version was bumped.\n5. Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can\n use `tox -e bumpversion -- minor` after.\n</details>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A data model and client for Wikidata QuickStatements",
"version": "0.0.6",
"project_urls": {
"Bug Tracker": "https://github.com/cthoyt/quickstatements_client/issues",
"Download": "https://github.com/cthoyt/quickstatements_client/releases",
"Homepage": "https://github.com/cthoyt/quickstatements_client",
"Source Code": "https://github.com/cthoyt/quickstatements_client"
},
"split_keywords": [
"snekpack",
" cookiecutter",
" wikidata",
" quickstatements",
" pydantic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "589c0e1dbf50ef5e056e3a46b1e25b5ae699cb04b6c4daf42cc1451d5747a886",
"md5": "8030c6f2eb61b311da5bac84df21f8f3",
"sha256": "4e76c835d53e1e23b7513042a26e6d5e9a61307e7e13013ae42a6b2aa22863fa"
},
"downloads": -1,
"filename": "quickstatements_client-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8030c6f2eb61b311da5bac84df21f8f3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 23585,
"upload_time": "2024-03-24T20:32:11",
"upload_time_iso_8601": "2024-03-24T20:32:11.897298Z",
"url": "https://files.pythonhosted.org/packages/58/9c/0e1dbf50ef5e056e3a46b1e25b5ae699cb04b6c4daf42cc1451d5747a886/quickstatements_client-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c5b7fc1855217a266918701e60d9df388b51eecebd3c7d5bf7a709846860891d",
"md5": "66acff2384ee42a85c61bbbf3b2c6227",
"sha256": "eee0000d2ea4d7b18137eb251f9e499373c13b66f837515da22d0b9123075b00"
},
"downloads": -1,
"filename": "quickstatements_client-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "66acff2384ee42a85c61bbbf3b2c6227",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 38053,
"upload_time": "2024-03-24T20:32:13",
"upload_time_iso_8601": "2024-03-24T20:32:13.918929Z",
"url": "https://files.pythonhosted.org/packages/c5/b7/fc1855217a266918701e60d9df388b51eecebd3c7d5bf7a709846860891d/quickstatements_client-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-24 20:32:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cthoyt",
"github_project": "quickstatements_client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "quickstatements-client"
}
JSON
