Lightning Utilities
This repository covers the following use-cases:
- Reusable GitHub workflows
- Shared GitHub actions
- General Python utilities in
lightning_utilities.core - 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-24.04
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.10
- uses: Lightning-AI/utilities/.github/actions/cache
with:
python-version: 3.10
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
Release files for lightning-utilities 0.15.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| lightning_utilities-0.15.3.tar.gz | 33.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| lightning_utilities-0.15.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 65.5 kB
Release files / lightning_utilities-0.15.3.tar.gz
| Download URL | lightning_utilities-0.15.3.tar.gz |
|---|---|
| Size | 33.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
792ae0204c79f6859721ac7f386c237a33b0ed06ba775009cb894e010a842033
|
|
BLAKE2b-256 checksum How to use checksums |
f1457fa8f56b17dc0f0a41ec70dd307ecd6787254483549843bef4c30ab5adce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / lightning_utilities-0.15.3-py3-none-any.whl
| Download URL | lightning_utilities-0.15.3-py3-none-any.whl |
|---|---|
| Size | 31.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6c55f1bee70084a1cbeaa41ada96e4b3a0fea5909e844dd335bd80f5a73c5f91
|
|
BLAKE2b-256 checksum How to use checksums |
25f4ead6e0e37209b07c9baa3e984ccdb0348ca370b77cea3aaea8ddbb097e00
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
