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.org/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.org/simple/flask)>)

Using the CLI:

$ unearth "flask>=2"
{
  "name": "flask",
  "version": "2.1.2",
  "link": {
    "url": "https://files.pythonhosted.org/packages/ba/76/e9580e494eaf6f09710b0f3b9000c9c0363e44af5390be32bb0394165853/Flask-2.1.2-py3-none-any.whl#sha256=fad5b446feb0d6db6aec0c3184d16a8c1f6c3e464b511649c8918a9be100b4fe",
    "comes_from": "https://pypi.org/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.11.0.tar.gz (271.2 kB view details)

Uploaded Source

Built Distribution

unearth-0.11.0-py3-none-any.whl (41.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for unearth-0.11.0.tar.gz
Algorithm Hash digest
SHA256 af20729b398d2f3b839251d745e4f40f23cb09bd6b797e0a6ff6eed46ca70422
MD5 0dbf0389784e1d285ef8e735ff47445e
BLAKE2b-256 92059b871e2262113d6b275cf0c57548a1aa15daa1c2fd96b5a308bf23995e81

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for unearth-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 81eae966dd66b23dd578ff14ca155a5387d3596fbe2b44212508090143c250a2
MD5 ada791ab431d18ff9645b74b95aedbeb
BLAKE2b-256 0a2a40a100a02fb21eb5c4ce49e8fb1e69e404967ea3b8bff90d43b2f37e8b9e

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