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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: unearth-0.15.1.tar.gz
  • Upload date:
  • Size: 283.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.13

File hashes

Hashes for unearth-0.15.1.tar.gz
Algorithm Hash digest
SHA256 863deb3339c0d65a5be0d0ad2c67d46d5f574a798e74ef0552bf11d298a30abb
MD5 6eb41cb20c37e0321323b43de1f003e7
BLAKE2b-256 428cb9649ad9d54de4ed0b978527f6d7576526290db905e33a28895b585778da

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for unearth-0.15.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e76dc2e3ce64fe0888fca4e0f60607e7be42cd033e1b8e6a6e49d8cf3c20c874
MD5 2c18c9174a55a3811137a028dfdb34b8
BLAKE2b-256 d306d49bb5ae88757e4a7325b12a3906531f92d1c7c79f720bd954c198e26cea

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