Skip to main content

A utility to fetch and download python packages

Project description

unearth

Tests pypi version Code style: black pdm-managed

A utility to fetch and download python packages

NOTICE This project is still in its early stage and the API may change before 1.0 release.

Why this project?

This project exists as the last piece to complete the puzzle of a package manager. The other pieces are:

  • resolvelib - Resolves concrete dependencies from a set of (abstract) requirements.
  • unearth (This project) - Finds and downloads the best match(es) for a given requirement.
  • build - Builds wheels from the source code.
  • installer - Installs packages from wheels.

They provide all the low-level functionalities that are needed to resolve and install packages.

Why not pip?

The core functionality is basically extracted from pip. However, pip is not designed to be used as a library and hence the API is not very stable. Unearth serves as a stable replacement for pip's PackageFinder API. It will follow the conventions of Semantic Versioning so that downstream projects can use it to develop their own package finding and downloading.

Requirements

unearth requires Python >=3.7

Installation

$ python -m pip install --upgrade unearth

Quickstart

Get the best matching candidate for a requirement:

>>> from unearth import PackageFinder
>>> finder = PackageFinder(index_urls=['https://pypi-hypernode.com/simple/'])
>>> result = finder.find_best_match("flask>=2")
>>> result.best_candidate
Package(name='flask', version='2.1.2', link=<Link https://files.pythonhosted.org/packages/ba/76/e9580e494eaf6f09710b0f3b9000c9c0363e44af5390be32bb0394165853/Flask-2.1.2-py3-none-any.whl#sha256=fad5b446feb0d6db6aec0c3184d16a8c1f6c3e464b511649c8918a9be100b4fe (from https://pypi-hypernode.com/simple/flask)>)

Using the CLI:

$ unearth "flask>=2"
{
  "name": "flask",
  "version": "2.1.2",
  "link": {
    "url": "https://pypi-hypernode.com/packages/ba/76/e9580e494eaf6f09710b0f3b9000c9c0363e44af5390be32bb0394165853/Flask-2.1.2-py3-none-any.whl#sha256=fad5b446feb0d6db6aec0c3184d16a8c1f6c3e464b511649c8918a9be100b4fe",
    "comes_from": "https://pypi-hypernode.com/simple/flask",
    "yank_reason": null,
    "requires_python": ">=3.7"
  }
}

Documentation

Read the docs

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

unearth-0.6.1.tar.gz (266.7 kB view details)

Uploaded Source

Built Distribution

unearth-0.6.1-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

Details for the file unearth-0.6.1.tar.gz.

File metadata

  • Download URL: unearth-0.6.1.tar.gz
  • Upload date:
  • Size: 266.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for unearth-0.6.1.tar.gz
Algorithm Hash digest
SHA256 4b7bfbd7d34a11673d80dfae7fabbf921c139aac78383fb0ca16a90d3b53a66e
MD5 493ae7a6eb54ee66767ba30a6ae8f798
BLAKE2b-256 4495e53610248a8a590f2b5e716e173ca1b6b6f97734fa361069d316addac7ad

See more details on using hashes here.

Provenance

File details

Details for the file unearth-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: unearth-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 38.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for unearth-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3aad41a7657ad27d00895b6bd9925da0045fc843da06080488cf1b6d77b496ad
MD5 0db05204325e37cdff4513f8fe25e853
BLAKE2b-256 498aa1f2213ba0e1afff6a2bbdd4e9fe6e98b5408dde2d48473e31b94c1e87bb

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