Skip to main content

Get one-liner commands for faster python environment uv python manager.

Project description

Uvify

PyPI version

Turn python repositories to uv environments and oneliners, without diving into the code.

  • Generates oneliners for quick python environment setup
  • Helps with migration to uv for faster builds in CI/CD
  • It works on existing projects based on: requirements.txt, pyproject.toml or setup.py, recursively.
    • Supports local directories.
    • Supports GitHub links using Git Ingest.
  • It's fast!

Prerequisites

| uv

Demo

https://huggingface.co/spaces/avilum/uvify

Star History Chart

uv is by far the fastest python and package manager.

Source: https://github.com/astral-sh/uv

You can run uvify with uv.
Let's generate oneliners for a virtual environment that has requests installed, using PyPi or from source:

# Run on a local directory
uvx uvify . | jq

# Run on requests
uvx uvify https://github.com/psf/requests | jq
# or:
# uvx uvify psf/requests | jq

[
  ...
  {
    "file": "setup.py",
    "fileType": "setup.py",
    "oneLiner": "uv run --python '>=3.8.10' --with 'certifi>=2017.4.17,charset_normalizer>=2,<4,idna>=2.5,<4,urllib3>=1.21.1,<3,requests' python -c 'import requests; print(requests)'",
    "uvInstallFromSource": "uv run --with 'git+https://github.com/psf/requests' --python '>=3.8.10' python",
    "dependencies": [
      "certifi>=2017.4.17",
      "charset_normalizer>=2,<4",
      "idna>=2.5,<4",
      "urllib3>=1.21.1,<3"
    ],
    "packageName": "requests",
    "pythonVersion": ">=3.8",
    "isLocal": false
  }
]

Parse all python artifacts in repository:

uvify psf/requests
uvify https://github.com/psf/requests

Parse specific fields in the response

uvify psf/black | jq '.[] | {file: .file, pythonVersion: .pythonVersion, dependencies: .dependencies, packageName: .packageName}'

Use existing python repos with 'uv':

uvify psf/requests | jq '.[0].oneLiner'
"uv run --with 'git+https://github.com/psf/requests' --python '3.11' python"

Install a repository with 'uv' from github sources:

uvify psf/requests | jq '.[0].dependencies'

List the dependencies.

uvify psf/requests | jq '.[].dependencies'
[
  "certifi>=2017.4.17",
  "charset_normalizer>=2,<4",
  "idna>=2.5,<4",
  "urllib3>=1.21.1,<3"
]

Filtering Options

Uvify supports filtering which files to analyze using include and exclude patterns with glob syntax.

Exclude directories from analysis

Skip test directories and any paths matching the pattern:

uvify --exclude "tests/*" --exclude "test_*" my-project/

Include only specific directories

Analyze only files in the src/ directory:

uvify --include "src/*" my-project/

Analyze only a specific subdirectory:

uvify --include "src/my_app/*" my-project/

Combine include and exclude patterns

Include everything in src/ but exclude test files:

uvify --include "src/*" --exclude "*/test_*" --exclude "*/tests/*" my-project/

GitHub repositories with filtering

The filtering also works with GitHub repositories:

# Exclude test directories from a GitHub repo
uvify --exclude "tests/*" psf/requests

# Only analyze specific subdirectories  
uvify --include "src/*" --include "lib/*" myorg/myrepo

Pattern Examples

  • tests/* - Excludes any directory named "tests" and all its contents
  • test_* - Excludes any file or directory starting with "test_"
  • */tests/* - Excludes "tests" directories at any depth
  • src/my_app/* - Includes only files within the "src/my_app/" directory
  • *.py - Includes only Python files

Note: By default, uvify scans all directories for requirements.txt, pyproject.toml, and setup.py files. The include/exclude patterns filter which of these files to analyze based on their path.

Uvify HTTP Server: Using uvify with client/server architecture instead of SDK

First, install uvify with the optional API dependencies:

uv add uvify[api]
# or with pip:
# pip install uvify[api]

Then run the server:

# Run the server using the built-in serve command
uvify serve --host 0.0.0.0 --port 8000

# Or using uvicorn directly
uv run uvicorn src.uvify:api --host 0.0.0.0 --port 8000

# Using curl
curl http://0.0.0.0:8000/psf/requests | jq

# Using wget
wget -O-  http://0.0.0.0:8000/psf/requests | jq

Developing

# Install dependencies (including optional API dependencies)
uv venv
uv sync --dev --extra api
uv run pytest

# Run linter before PR 
./lint.sh

# Install editable version locally
uv run pip install --editable .
uv run python -m src.uvify --help
uv run python -m src.uvify psf/requests

# Run the HTTP API with reload
uv run uvicorn src.uvify:api --host 0.0.0.0 --port 8000 --reload 
# Or use the built-in serve command:
# uv run python -m src.uvify serve --host 0.0.0.0 --port 8000

curl http://0.0.0.0:8000/psf/requests | jq

Special Thanks

Thanks to the UV team and Astral for this amazing tool.

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

uvify-0.1.7.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uvify-0.1.7-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file uvify-0.1.7.tar.gz.

File metadata

  • Download URL: uvify-0.1.7.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for uvify-0.1.7.tar.gz
Algorithm Hash digest
SHA256 1e2655041bfb228aaa3c0e661412bba08c15cd3ca80110594649f28ccc3447d6
MD5 256de25438ccba11dfae025aaca0c19e
BLAKE2b-256 bceff6ea07af98a1162bdf9affbb5395424e3aeae29c7f707fa02cee9b0686e0

See more details on using hashes here.

File details

Details for the file uvify-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: uvify-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 11.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for uvify-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 8479ecfc273116416643305e0a43702980f41ee404119ac9d7506583f9e603a5
MD5 d0f48e797e2556c515cf2b7ac042e85b
BLAKE2b-256 e826cc19acd25d9a9ff4d23b3263426cb4efe5faeb674f2f44760bacdd233edf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page