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@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.5.0.tar.gz
(17.4 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.5.0.tar.gz.
File metadata
- Download URL: lightning-utilities-0.5.0.tar.gz
- Upload date:
- Size: 17.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
01ef5b7fd50a8b54b849d8621720a65c36c91b374933a8384fb2be3d86cfa8f1
|
|
| MD5 |
7246b763b7bb94d0d16325797c1eebf9
|
|
| BLAKE2b-256 |
e7705980630b9466ad005ad42d2f882e087ae572a1487933e525b8035fc6d471
|
File details
Details for the file lightning_utilities-0.5.0-py3-none-any.whl.
File metadata
- Download URL: lightning_utilities-0.5.0-py3-none-any.whl
- Upload date:
- Size: 18.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
db1fa4300ce76b171d8cd4e78ffad3b6bc82f3fbe8ca5aa35da269fbda65bea3
|
|
| MD5 |
71217adcaa22c64e9a29e5bb91a843c0
|
|
| BLAKE2b-256 |
f2370c1e403717ad981f1ae407771a4e6f6be4407ed4f532b5c41703d5a33104
|
