Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cthoyt/quickstatements_client
A data model and client for QuickStatements (for Wikidata)
https://github.com/cthoyt/quickstatements_client
bibliometrics python quickstatements wikidata
Last synced: 16 days ago
JSON representation
A data model and client for QuickStatements (for Wikidata)
- Host: GitHub
- URL: https://github.com/cthoyt/quickstatements_client
- Owner: cthoyt
- License: mit
- Created: 2023-02-25T16:48:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-13T11:19:05.000Z (about 1 month ago)
- Last Synced: 2024-10-14T02:23:37.592Z (about 1 month ago)
- Topics: bibliometrics, python, quickstatements, wikidata
- Language: Python
- Homepage: https://quickstatements-client.readthedocs.io
- Size: 116 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
QuickStatements Client
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.
### 🍪 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
See developer instructions
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.