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 Ruff Contributor Covenant DOI

Idiomatic conversion between URIs and compact URIs (CURIEs).

import curies

converter = curies.load_prefix_map({
    "CHEBI": "http://purl.obolibrary.org/obo/CHEBI_",
    # ... and so on
})

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

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

Full documentation is available at curies.readthedocs.io.

CLI Usage

This package comes with a built-in CLI for running a resolver web application or a IRI mapper web application:

# Run a resolver
python -m curies resolver --host 0.0.0.0 --port 8764 bioregistry

# Run a mapper
python -m curies mapper --host 0.0.0.0 --port 8764 bioregistry

The positional argument can be one of the following:

  1. A pre-defined prefix map to get from the web (bioregistry, go, obo, monarch, prefixcommons)
  2. A local file path or URL to a prefix map, extended prefix map, or one of several formats. Requires specifying a --format.

The framework can be swapped to use Flask (default) or FastAPI with --framework. The server can be swapped to use Werkzeug (default) or Uvicorn with --server. These functionalities are also available programmatically, see the docs for more information.

🧑‍🤝‍🧑 Related

Other packages that convert between CURIEs and URIs:

🚀 Installation

The most recent release can be installed from PyPI with:

python3 -m pip install curies

As of v0.8, this package only supports Pydantic v2. v0.6.x and v0.7.x had cross-version support for Pydantic v1 and v2. v0.5.x and before only supported Pydantic v1. See the Pydantic migration guide for updating your code.

👐 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/biopragmatics/curies.git
cd curies
python3 -m pip install -e .

Updating Package Boilerplate

This project uses cruft to keep boilerplate (i.e., configuration, contribution guidelines, documentation configuration) up-to-date with the upstream cookiecutter package. Update with the following:

python3 -m pip install cruft
cruft update

More info on Cruft's update command is available here.

🥼 Testing

After cloning the repository and installing tox with python3 -m pip install tox tox-uv, the unit tests in the tests/ folder can be run reproducibly with:

tox -e py

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/biopragmatics/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 pyproject.toml. sphinx plugins like texext can be added there. Additionally, they need to be added to the extensions list in docs/source/conf.py.

The documentation can be deployed to ReadTheDocs using this guide. The .readthedocs.yml YAML file contains all the configuration you'll need. You can also set up continuous integration on GitHub to check not only that Sphinx can build the documentation in an isolated environment (i.e., with tox -e docs-test) but also that ReadTheDocs can build it too.

Configuring ReadTheDocs

  1. Log in to ReadTheDocs with your GitHub account to install the integration at https://readthedocs.org/accounts/login/?next=/dashboard/
  2. Import your project by navigating to https://readthedocs.org/dashboard/import then clicking the plus icon next to your repository
  3. You can rename the repository on the next screen using a more stylized name (i.e., with spaces and capital letters)
  4. Click next, and you're good to go!

📦 Making a Release

Configuring Zenodo

Zenodo is a long-term archival system that assigns a DOI to each release of your package.

  1. Log in to Zenodo via GitHub with this link: https://zenodo.org/oauth/login/github/?next=%2F. This brings you to a page that lists all of your organizations and asks you to approve installing the Zenodo app on GitHub. Click "grant" next to any organizations you want to enable the integration for, then click the big green "approve" button. This step only needs to be done once.
  2. Navigate to https://zenodo.org/account/settings/github/, which lists all of your GitHub repositories (both in your username and any organizations you enabled). Click the on/off toggle for any relevant repositories. When you make a new repository, you'll have to come back to this

After these steps, you're ready to go! After you make "release" on GitHub (steps for this are below), you can navigate to https://zenodo.org/account/settings/github/repository/biopragmatics/curies to see the DOI for the release and link to the Zenodo record for it.

Registering with the Python Package Index (PyPI)

You only have to do the following steps once.

  1. Register for an account on the Python Package Index (PyPI)
  2. Navigate to https://pypi-hypernode.com/manage/account and make sure you have verified your email address. A verification email might not have been sent by default, so you might have to click the "options" dropdown next to your address to get to the "re-send verification email" button
  3. 2-Factor authentication is required for PyPI since the end of 2023 (see this blog post from PyPI). This means you have to first issue account recovery codes, then set up 2-factor authentication
  4. Issue an API token from https://pypi-hypernode.com/manage/account/token

Configuring your machine's connection to PyPI

You have to do the following steps once per machine. Create a file in your home directory called .pypirc and include the following:

[distutils]
index-servers =
    pypi
    testpypi

[pypi]
username = __token__
password = <the API token you just got>

# This block is optional in case you want to be able to make test releases to the Test PyPI server
[testpypi]
repository = https://test.pypi.org/legacy/
username = __token__
password = <an API token from test PyPI>

Note that since PyPI is requiring token-based authentication, we use __token__ as the user, verbatim. If you already have a .pypirc file with a [distutils] section, just make sure that there is an index-servers key and that pypi is in its associated list. More information on configuring the .pypirc file can be found here.

Uploading to PyPI

After installing the package in development mode and installing tox with python3 -m pip install tox tox-uv, run the following from the console:

tox -e finish

This script does the following:

  1. Uses bump-my-version to switch the version number in the pyproject.toml, CITATION.cff, 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 uv build
  3. Uploads to PyPI using twine upload. This will be replaced soon with uv publish (see https://github.com/cthoyt/cookiecutter-snekpack/issues/29)
  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.

Releasing on GitHub

  1. Navigate to https://github.com/biopragmatics/curies/releases/new to draft a new release
  2. Click the "Choose a Tag" dropdown and select the tag corresponding to the release you just made
  3. Click the "Generate Release Notes" button to get a quick outline of recent changes. Modify the title and description as you see fit
  4. Click the big green "Publish Release" button

This will trigger Zenodo to assign a DOI to your release as well.

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.9.0.tar.gz (63.4 kB view details)

Uploaded Source

Built Distribution

curies-0.9.0-py3-none-any.whl (49.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: curies-0.9.0.tar.gz
  • Upload date:
  • Size: 63.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for curies-0.9.0.tar.gz
Algorithm Hash digest
SHA256 f630fa05b31aff144da66ace18a2c25b30adfa859df36e5fbd8b633b43c80d3a
MD5 143c6b3d0336e3392bb87c77cf9f1701
BLAKE2b-256 b0dde072bfc80d8a476a031211848007df3a2c43695072a8053750b259f3ff58

See more details on using hashes here.

File details

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

File metadata

  • Download URL: curies-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 49.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for curies-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a4b8d9fff89288190c658ac5941f3099196205cd805cc98fceba1ac5a96daa50
MD5 93f9ee774510fc0e618e2572713170c3
BLAKE2b-256 411f9cc2627b8654f949e2d07c1e316bcacbd8e1fd9ad4d9c5d5ec9fceea0184

See more details on using hashes here.

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