Skip to main content
Yanked

This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 0.15.3 instead.

Lightning Utilities

UnitTests Apply checks Documentation Status pre-commit.ci status

This repository covers the following use-cases:

  1. GitHub workflows
  2. GitHub actions
  3. CLI lightning_utilities.cli
  4. General Python utilities in lightning_utilities.core

1. Reusable workflows

Usage:

name: Check schema

on: [push]

jobs:
  check-schema:
    uses: Lightning-AI/utilities/.github/workflows/check-schema.yml@main
    with:
      azure-dir: ""

See usage of other workflows in .github/workflows/ci_use-checks.yml.

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
        # requires: latest

3. CLI lightning_utilities.cli

The package provides common CLI commands.

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

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

4. General Python utilities lightning_utilities.core

Installation

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

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

Uploaded Source

Built Distribution

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

lightning_utilities-0.4.0-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

Details for the file lightning-utilities-0.4.0.tar.gz.

File metadata

  • Download URL: lightning-utilities-0.4.0.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for lightning-utilities-0.4.0.tar.gz
Algorithm Hash digest
SHA256 961c29774c2c8303e0a2f6e6512a2e21e1d8acaf6df182865667af4a51bc176c
MD5 d3bd7fbb67ca1de40ea19d9695ff5a90
BLAKE2b-256 2074ccb43dd35412d58a46772bcefae7dbc2a078798047a1605e558370bbe8d0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lightning_utilities-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 36d257f9eb9e1cb2669a43ca200d1dd4a0b4840768b38d9f69a892ff004cb412
MD5 cb3e0030bf9eacf8d6876ead7f21302c
BLAKE2b-256 6717bed12398a0417be28970bb3f8252a36ae0b2bc0d580b0dcddf6ad5d89a62

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