Skip to main content

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

CI Tests and build status

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)

Other utilities:

  • packageurl.contrib.django_models.PackageURLMixin is a Django abstract model mixin to use Package URLs in Django.

  • packageurl.contrib.purl2url.get_url(purl) returns the download URL inferred from a Package URL.

  • packageurl.contrib.url2purl.get_purl(url) returns a Package URL inferred from URL.

Install

pip install packageurl-python

Run tests

install:

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 and AUTHORS.rst

  • update 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

  • tag and push that tag

  • make a PR to merge branch

  • once merged, run:

    bin/pip install --upgrade pip wheel twine setuptools
  • delete the “dist” and “build” directories:

    rm -rf dist/ build/
  • create a source distribution and wheel with:

    bin/python setup.py sdist bdist_wheel
  • finally, upload to PyPI:

    bin/twine upload dist/*

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

packageurl-python-0.10.2.tar.gz (31.7 kB view details)

Uploaded Source

Built Distribution

packageurl_python-0.10.2-py3-none-any.whl (26.6 kB view details)

Uploaded Python 3

File details

Details for the file packageurl-python-0.10.2.tar.gz.

File metadata

  • Download URL: packageurl-python-0.10.2.tar.gz
  • Upload date:
  • Size: 31.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.10

File hashes

Hashes for packageurl-python-0.10.2.tar.gz
Algorithm Hash digest
SHA256 b2e58533888ebb441f56faaef324a0df20e4f700505346c3cabe9a713ee7c842
MD5 8d75518a29aa3f1ef153d81b10207731
BLAKE2b-256 bf29ca08a294d841d7b44996d28d17b9fb64a2ed2f8c29c1ded2762731518139

See more details on using hashes here.

File details

Details for the file packageurl_python-0.10.2-py3-none-any.whl.

File metadata

File hashes

Hashes for packageurl_python-0.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ff6a4271ca6e433bcd1f51daf47f5f9d9b7229d9137cf2b16ad3e8a5a847d91d
MD5 97f9a3ab830e9a2205b910ab701679ec
BLAKE2b-256 4b146ddff009e8d127a7ab244fe8255e5f2b326d63eda4e622cff07a9cc20258

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