Skip to main content

Idiomatic conversion between URIs and compact URIs (CURIEs).

Project description

curies

Tests PyPI PyPI - Python Version PyPI - License Documentation Status Codecov status Cookiecutter template from @cthoyt Code style: black Contributor Covenant DOI

Idiomatic conversion between URIs and compact URIs (CURIEs).

from curies import Converter

converter = Converter.from_prefix_map({
   "CHEBI": "http://purl.obolibrary.org/obo/CHEBI_",
   "MONDO": "http://purl.obolibrary.org/obo/MONDO_",
   "GO": "http://purl.obolibrary.org/obo/GO_",
   # ... and so on
   "OBO": "http://purl.obolibrary.org/obo/",
})

>>> converter.compress("http://purl.obolibrary.org/obo/CHEBI_1")
'CHEBI:1'

>>> converter.expand("CHEBI:1")
'http://purl.obolibrary.org/obo/CHEBI_1'

# Unparsable
>>> assert converter.compress("http://example.com/missing:0000000") is None
>>> assert converter.expand("missing:0000000") is None

When some URI prefixes are partially overlapping (e.g., http://purl.obolibrary.org/obo/GO_ for GO and http://purl.obolibrary.org/obo/ for OBO), the longest URI prefix will always be matched. For example, parsing http://purl.obolibrary.org/obo/GO_0032571 will return GO:0032571 instead of OBO:GO_0032571.

A converter can be instantiated from a web-based resource in JSON-LD format:

from curies import Converter

url = "https://raw.githubusercontent.com/biopragmatics/bioregistry/main/exports/contexts/semweb.context.jsonld"
converter = Converter.from_jsonld_url(url)

Several converters can be instantiated from pre-defined web-based resources:

import curies

# Uses the Bioregistry, an integrative, comprehensive registry
bioregistry_converter = curies.get_bioregistry_converter()

# Uses the OBO Foundry, a registry of ontologies
obo_converter = curies.get_obo_converter()

# Uses the Monarch Initative's project-specific context
monarch_converter = curies.get_monarch_converter()

Apply in bulk to a pandas.DataFrame with Converter.pd_expand and Converter.pd_compress:

import curies
import pandas as pd

df = pd.read_csv(...)
obo_converter = curies.get_obo_converter()
obo_converter.pd_compress(df, column=0)
obo_converter.pd_expand(df, column=0)

Apply in bulk to a CSV file with Converter.file_expand and Converter.file_compress (defaults to using tab separator):

import curies

path = ...
obo_converter = curies.get_obo_converter()
# modifies file in place
obo_converter.file_compress(path, column=0)
# modifies file in place
obo_converter.file_expand(path, column=0)

Full documentation is available here.

🧑‍🤝‍🧑 Related

Other packages that convert between CURIEs and URIs:

🚀 Installation

The most recent release can be installed from PyPI with:

$ pip install curies

👐 Contributing

Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.md for more information on getting involved.

👋 Attribution

🙏 Acknowledgements

This package heavily builds on the trie data structure implemented in pytrie.

⚖️ License

The code in this package is licensed under the MIT License.

🍪 Cookiecutter

This package was created with @audreyfeldroy's cookiecutter package using @cthoyt's 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:

$ git clone git+https://github.com/cthoyt/curies.git
$ cd curies
$ 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:

$ tox

Additionally, these tests are automatically re-run with each commit in a GitHub Action.

📖 Building the Documentation

The documentation can be built locally using the following:

$ git clone git+https://github.com/cthoyt/curies.git
$ cd curies
$ 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. sphinx plugins like texext can be added there. Additionally, they need to be added to the extensions list in 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:

$ tox -e finish

This script does the following:

  1. Uses Bump2Version to switch the version number in the setup.cfg, src/curies/version.py, and docs/source/conf.py to not have the -dev suffix
  2. Packages the code in both a tar archive and a wheel using build
  3. Uploads to PyPI using 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

curies-0.3.0.tar.gz (19.4 kB view details)

Uploaded Source

Built Distribution

curies-0.3.0-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file curies-0.3.0.tar.gz.

File metadata

  • Download URL: curies-0.3.0.tar.gz
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for curies-0.3.0.tar.gz
Algorithm Hash digest
SHA256 e2efff21fed623b55d1cfd9cf18d42e133c6ca0a6ddc42e7c023ca85d62ffdb5
MD5 41f8c5f41cfd9951f632357b51700889
BLAKE2b-256 19a1d46e26e65056bf3aa8bbd02766aa33d281480a9b6c30b750560d3c0aa5d0

See more details on using hashes here.

Provenance

File details

Details for the file curies-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: curies-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 12.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for curies-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0ac091b6a87103c6ebc11aee66a5cab48d3d4d8df5c894f222584932036daa18
MD5 18f18bebc275123414208b1fa7297afe
BLAKE2b-256 7071de8414e50f22e3fb1ba4c98a0c3e6054864747af01e1d7d7ad8419ed24d6

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page