Lightning toolbox for across the our ecosystem.
Project description
Lightning Utilities
This repository covers the following use-cases:
- Reusable GitHub workflows
- Shared GitHub actions
- CLI
python -m lightning_utilities.cli --help
- 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
Project details
Release history Release notifications | RSS feed
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.11.5.tar.gz
(28.1 kB
view hashes)
Built Distribution
Close
Hashes for lightning_utilities-0.11.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a96bee6d8b3df18b7c1a8dec83b2adb03dca6ca0ce3ae9fd355eb0922c4e5e07 |
|
MD5 | db7604935f7a91056db2aea5488518b1 |
|
BLAKE2b-256 | d4afdba1228d9e273d2b6594506782ab66fee22ff577adae92a245e08f10ea33 |
Close
Hashes for lightning_utilities-0.11.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab2117cc926a9e3757919e25a0da574badb1c0f04fc931849235731b78016a8d |
|
MD5 | 7a88f1c97f24f6af52d1b313661e03af |
|
BLAKE2b-256 | 36bb8577ddf395654b1790fd433d83c26bd3b236f515a3f7b02e445d4a0797a6 |