Lightning Utilities
This repository covers the following use-cases:
- GitHub workflows
- GitHub actions
- CLI
lightning_utilities.cli - 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@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. 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.9.0.tar.gz
(23.9 kB
view details)
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.9.0.tar.gz.
File metadata
- Download URL: lightning-utilities-0.9.0.tar.gz
- Upload date:
- Size: 23.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
efbf2c488c257f942abdfd06cf646fb84ca215a9663b60081811e22a15ee033b
|
|
| MD5 |
ecfc43f9a814375ee205f848e2045c37
|
|
| BLAKE2b-256 |
ddc00850bf9930c85ec68153e096662735bc1df2e4dab9acb469e2dfa72a0f9a
|
File details
Details for the file lightning_utilities-0.9.0-py3-none-any.whl.
File metadata
- Download URL: lightning_utilities-0.9.0-py3-none-any.whl
- Upload date:
- Size: 23.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
918dd90c775719e3855631db6282ad75c14da4c5727c4cebdd1589d865fad03d
|
|
| MD5 |
f7af44dc4337dd4be0b830e3990c4b5b
|
|
| BLAKE2b-256 |
46ee8641eeb6a062f383b7d6875604e1f3f83bd2c93a0b4dbcabd3150b32de6e
|
