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

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.8

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
Package(name='flask', version='2.1.2')

Using the CLI:

$ unearth "flask>=2"
{
  "name": "flask",
  "version": "3.0.0",
  "link": {
    "url": "https://pypi-hypernode.com/packages/36/42/015c23096649b908c809c69388a805a571a3bea44362fe87e33fc3afa01f/flask-3.0.0-py3-none-any.whl",
    "comes_from": "https://pypi-hypernode.com/simple/flask/",
    "yank_reason": null,
    "requires_python": ">=3.8",
    "metadata": "https://pypi-hypernode.com/packages/36/42/015c23096649b908c809c69388a805a571a3bea44362fe87e33fc3afa01f/flask-3.0.0-py3-none-any.whl.metadata"
  }
}

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

Uploaded Source

Built Distribution

unearth-0.17.1-py3-none-any.whl (47.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: unearth-0.17.1.tar.gz
  • Upload date:
  • Size: 284.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for unearth-0.17.1.tar.gz
Algorithm Hash digest
SHA256 4ecd9c2bf9d65ee1476a93219cc823eb54ca49080555de575529567658fd6395
MD5 ef8b4ac1c41b7918f6c6f9c538ef2d34
BLAKE2b-256 bb410d518fc6ab8ff137de353045032bd2fdbc559cf6d841ee5c19824edc3b1b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: unearth-0.17.1-py3-none-any.whl
  • Upload date:
  • Size: 47.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for unearth-0.17.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4559d8bef08077ae3d20d9fbb10712e45e2f40f85d8e47e58d9f57ec552ecd57
MD5 0a8fd90b3956b032e2d3bd56ef42586a
BLAKE2b-256 9b9643d4bb32f4bd7c2e0b22ca67b1d23d4b87219a3c69524033a7c95ca73f47

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