A purl aka. Package URL parser and builder
Project description
Python library to parse and build “purl” aka. Package URLs. See https://github.com/package-url/purl-spec for details.
Join the discussion at https://gitter.im/package-url/Lobby or enter a ticket for support.
License: MIT
Tests and build status
Tests and build |
|---|
Install
pip install packageurl-python
Usage
>>> from packageurl import PackageURL
>>> purl = PackageURL.from_string("pkg:maven/org.apache.commons/io@1.3.4")
>>> print(purl.to_dict())
{'type': 'maven', 'namespace': 'org.apache.commons', 'name': 'io', 'version': '1.3.4', 'qualifiers': None, 'subpath': None}
>>> print(purl.to_string())
pkg:maven/org.apache.commons/io@1.3.4
>>> print(str(purl))
pkg:maven/org.apache.commons/io@1.3.4
>>> print(repr(purl))
PackageURL(type='maven', namespace='org.apache.commons', name='io', version='1.3.4', qualifiers={}, subpath=None)
Utilities
Django models
packageurl.contrib.django.models.PackageURLMixin is a Django abstract model mixin to use Package URLs in Django.
SQLAlchemy mixin
packageurl.contrib.sqlalchemy.mixin.PackageURLMixin is a SQLAlchemy declarative mixin to use Package URLs in SQLAlchemy models.
URL to PURL
packageurl.contrib.url2purl.get_purl(url) returns a Package URL inferred from an URL.
>>> from packageurl.contrib import url2purl
>>> url2purl.get_purl("https://github.com/package-url/packageurl-python")
PackageURL(type='github', namespace='package-url', name='packageurl-python', version=None, qualifiers={}, subpath=None)
PURL to URL
packageurl.contrib.purl2url.get_repo_url(purl) returns a repository URL inferred from a Package URL.
packageurl.contrib.purl2url.get_download_url(purl) returns a download URL inferred from a Package URL.
packageurl.contrib.purl2url.get_inferred_urls(purl) return all inferred URLs (repository, download) from a Package URL.
>>> from packageurl.contrib import purl2url
>>> purl2url.get_repo_url("pkg:gem/bundler@2.3.23")
"https://rubygems.org/gems/bundler/versions/2.3.23"
>>> purl2url.get_download_url("pkg:gem/bundler@2.3.23")
"https://rubygems.org/downloads/bundler-2.3.23.gem"
>>> purl2url.get_inferred_urls("pkg:gem/bundler@2.3.23")
["https://rubygems.org/gems/bundler/versions/2.3.23", "https://rubygems.org/downloads/bundler-2.3.23.gem"]
Run tests
Install test dependencies:
python3 thirdparty/virtualenv.pyz --never-download --no-periodic-update . bin/pip install -e ."[test]"
Run tests:
bin/py.test tests
Make a new release
Start a new release branch
Update the CHANGELOG.rst, AUTHORS.rst, and README.rst if needed
Bump version in setup.cfg
Run all tests
Install restview and validate that all .rst docs are correct
Commit and push this branch
Make a PR and merge once approved
Tag and push that tag. This triggers the pypi-release.yml workflow that takes care of building the dist release files and upload those to pypi:
VERSION=v0.x.x git tag -a $VERSION -m "Tag $VERSION" git push origin $VERSION
Review the GitHub release created by the workflow at https://github.com/package-url/packageurl-python/releases
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file packageurl_python-0.15.2.tar.gz.
File metadata
- Download URL: packageurl_python-0.15.2.tar.gz
- Upload date:
- Size: 39.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.19
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9cd10eeedbc6680728c10a1585c6dd7bbad4ef4b389d80cd0ac223205e9c87df |
|
| MD5 | 2d265da2a07ced20a36df0e84a297c07 |
|
| BLAKE2b-256 | b50c08dfe9c4bf1dbb4aa06e1095bdbe636095e3b02e8212d3def3ea77c94c44 |
Provenance
File details
Details for the file packageurl_python-0.15.2-py3-none-any.whl.
File metadata
- Download URL: packageurl_python-0.15.2-py3-none-any.whl
- Upload date:
- Size: 28.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.19
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6b81641aeedf0a73377d88a8a640e45a2a0848ffdf5447d24eeef8526c41ac92 |
|
| MD5 | e1add8160a7485ad760951216af3f80e |
|
| BLAKE2b-256 | e0c7c60ada86a33105aa41a88a1e06a2929fb77faf230d21ca682d167011a758 |
