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.8.0.tar.gz
(21.2 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.8.0.tar.gz.
File metadata
- Download URL: lightning-utilities-0.8.0.tar.gz
- Upload date:
- Size: 21.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8e5d95c7c57f026cdfed7c154303e88c93a7a5e868c9944cb02cf71f1db29720
|
|
| MD5 |
323c9a6a6e05939e7b0a1032af7d1803
|
|
| BLAKE2b-256 |
2711869a3de9da0919b8b2179e9b2a6b0d9cd095baa2600f5c1f8744f398c049
|
File details
Details for the file lightning_utilities-0.8.0-py3-none-any.whl.
File metadata
- Download URL: lightning_utilities-0.8.0-py3-none-any.whl
- Upload date:
- Size: 20.3 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 |
22aa107b51c8f50ccef54d08885eb370903eb04148cddb2891b9c65c59de2a6e
|
|
| MD5 |
5314e7a3972e31732944ddf05bf7d871
|
|
| BLAKE2b-256 |
5deca20c5d5f26894913da028110310ba55ee254e1b7ff0ff78441e4eeb7291f
|
