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

Uploaded Source

Built Distribution

unearth-0.15.4-py3-none-any.whl (47.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: unearth-0.15.4.tar.gz
  • Upload date:
  • Size: 283.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for unearth-0.15.4.tar.gz
Algorithm Hash digest
SHA256 fbd85ab3fdb096f99c8266a20a7578a8f3130ad49f47cea8b138c008883b7b61
MD5 29b867cc9173e3c3cb76217c5ff62cc0
BLAKE2b-256 6ef375e1a1edff2d5c0fa74b7f7857b607afc4b4866b1ead6b334e7ecb80e176

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: unearth-0.15.4-py3-none-any.whl
  • Upload date:
  • Size: 47.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for unearth-0.15.4-py3-none-any.whl
Algorithm Hash digest
SHA256 349c4ef65652b5378517245c7970979c96762a41d52feb59db1b627f2ee94376
MD5 b67850f9cd65f4a0a7a9367901feb80d
BLAKE2b-256 0129379db3ff69f92662d0d16aa78255736ce630bc5009b1e7d9d7b1010c4d77

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