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

Uploaded Source

Built Distribution

unearth-0.17.2-py3-none-any.whl (47.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for unearth-0.17.2.tar.gz
Algorithm Hash digest
SHA256 0b8a2afd3476f1ab6155fc579501ac47fffe43547d88a70e5a5b76a7fe6caa2c
MD5 f571bf7d1ac5054b332b0f2e17b026bb
BLAKE2b-256 de1f5664f19db1352460e42f32e39976d8498a0fe056f0495221f53a43599154

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for unearth-0.17.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4d21af1238a583835fca156322f7225382e718cdcc42d6278050a88e605c4ad5
MD5 895176f1313b8022fc083e4436aaf8f1
BLAKE2b-256 402f42e35e6826a8e941979a5a79517d6e15008140eaffe33a8c85c7dc336f6e

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