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.1.tar.gz
(27.6 kB
view hashes)
Built Distribution
Close
Hashes for lightning-utilities-0.11.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5002eaadfb8caa2cd2bb7b845748d4e8e77ac275137b66b10182db3ecb0e4867 |
|
MD5 | 50bb136c05996f7b7eb219031a379e07 |
|
BLAKE2b-256 | 3a42e900386cda132d45730f096052347bd985ce4e57293cbd0b33b2413ed140 |
Close
Hashes for lightning_utilities-0.11.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89381384c79efcc958682d0a618acde2d9ae737ad3c673353839ba8f12cd0085 |
|
MD5 | 7f2e026ac87669e5ad0572da554b5717 |
|
BLAKE2b-256 | 8a0da78ad0528f85a582425734c7367defb35e4d55df80dce9879dbda6b3f788 |