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.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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file lightning_utilities-0.13.0.tar.gz.
File metadata
- Download URL: lightning_utilities-0.13.0.tar.gz
- Upload date:
- Size: 29.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ace17a6ce18d290410d903412fc27aef60acdbfb88956fc048ab80ef74fcea7d
|
|
| MD5 |
31eb71cd970f4eda4f7543380efeeed6
|
|
| BLAKE2b-256 |
dd70f06dc5c24aa3ec95f7c3e6cd82a589121f7fbad5d7d74a364e4728348137
|
File details
Details for the file lightning_utilities-0.13.0-py3-none-any.whl.
File metadata
- Download URL: lightning_utilities-0.13.0-py3-none-any.whl
- Upload date:
- Size: 28.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aa538db18a805ad76d2c6b94e6fc4d2d9bff6f56bd4255c82805672aa3aea12f
|
|
| MD5 |
28fd1245f6384bf0a938df1ffc4ac928
|
|
| BLAKE2b-256 |
c089cc9657a7a6645505f9db13bb0dc4477570f5c05bcb39ca8183c8eb1a67b9
|
