Skip to main content

Lightning toolbox for across the our ecosystem.

Project description

Lightning Utilities

PyPI Status license PyPI - Downloads PyPI - Python Version

UnitTests Apply checks Docs Status pre-commit.ci status

This repository covers the following use-cases:

  1. Reusable GitHub workflows
  2. Shared GitHub actions
  3. General Python utilities in lightning_utilities.core
  4. CLI python -m lightning_utilities.cli --help

1. Reusable workflows

Usage:

name: Check schema

on: [push]

jobs:

  check-schema:
    uses: Lightning-AI/utilities/.github/workflows/check-schema.yml@v0.5.0
    with:
      azure-dir: ""  # skip Azure check

  check-code:
    uses: Lightning-AI/utilities/.github/workflows/check-code.yml@main
    with:
      actions-ref: main  # normally you shall use the same version as the workflow

See usage of other workflows in .github/workflows/ci-use-checks.yaml.

2. Reusable composite actions

See available composite actions .github/actions/.

Usage:

name: Do something with cache

on: [push]

jobs:
  pytest:
    runs-on: ubuntu-20.04
    steps:
    - uses: actions/checkout@v3
    - uses: actions/setup-python@v4
      with:
        python-version: 3.9
    - uses: Lightning-AI/utilities/.github/actions/cache
      with:
        python-version: 3.9
        requires: oldest # or latest

3. General Python utilities lightning_utilities.core

Installation From source:
pip install https://github.com/Lightning-AI/utilities/archive/refs/heads/main.zip

From pypi:

pip install lightning_utilities

Usage:

Example for optional imports:

from lightning_utilities.core.imports import module_available

if module_available("some_package.something"):
    from some_package import something

4. CLI lightning_utilities.cli

The package provides common CLI commands.

Installation

From pypi:

pip install lightning_utilities[cli]

Usage:

python -m lightning_utilities.cli [group] [command]
Example for setting min versions
$ cat requirements/test.txt
coverage>=5.0
codecov>=2.1
pytest>=6.0
pytest-cov
pytest-timeout
$ python -m lightning_utilities.cli requirements set-oldest
$ cat requirements/test.txt
coverage==5.0
codecov==2.1
pytest==6.0
pytest-cov
pytest-timeout

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

lightning_utilities-0.11.9.tar.gz (29.4 kB view details)

Uploaded Source

Built Distribution

lightning_utilities-0.11.9-py3-none-any.whl (28.4 kB view details)

Uploaded Python 3

File details

Details for the file lightning_utilities-0.11.9.tar.gz.

File metadata

  • Download URL: lightning_utilities-0.11.9.tar.gz
  • Upload date:
  • Size: 29.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for lightning_utilities-0.11.9.tar.gz
Algorithm Hash digest
SHA256 f5052b81344cc2684aa9afd74b7ce8819a8f49a858184ec04548a5a109dfd053
MD5 4fddb7cb3f0fed9b660e3fc4c38ebdf2
BLAKE2b-256 8c4d54d38e237ab437f25f191602373d99b89d1d047ad2a3bb5ad0d84ea5daa6

See more details on using hashes here.

File details

Details for the file lightning_utilities-0.11.9-py3-none-any.whl.

File metadata

File hashes

Hashes for lightning_utilities-0.11.9-py3-none-any.whl
Algorithm Hash digest
SHA256 ac6d4e9e28faf3ff4be997876750fee10dc604753dbc429bf3848a95c5d7e0d2
MD5 e921f64cd9c21ace608dde96be3f08aa
BLAKE2b-256 85f31305321a12c984405e26fc64b5d521569e9872fb811f4aace8e168099160

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