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.7.1.tar.gz
(19.5 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.7.1.tar.gz.
File metadata
- Download URL: lightning-utilities-0.7.1.tar.gz
- Upload date:
- Size: 19.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9748a5466490d6e45c2df60c1ee77ff37a1a660ea6313bc0832ab7317a081cef
|
|
| MD5 |
153a13271b12dd2512db809a744f2252
|
|
| BLAKE2b-256 |
468b5aafb751f93556a7f12866d00c70aceea7f239636732959a339e0bef923e
|
File details
Details for the file lightning_utilities-0.7.1-py3-none-any.whl.
File metadata
- Download URL: lightning_utilities-0.7.1-py3-none-any.whl
- Upload date:
- Size: 18.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a7c58e67831c17712736e38e8ad5b81dbf64184ce28684a502e896ecca939b67
|
|
| MD5 |
98cd78c9e644cf67c5dd5a960a312406
|
|
| BLAKE2b-256 |
5810e5f7a23c836b63960e936a75f805ee3d92c647ee39850837187219c83a43
|
