File size: 5,622 Bytes
9c6594c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
Metadata-Version: 2.4
Name: lightning-utilities
Version: 0.14.3
Summary: Lightning toolbox for across the our ecosystem.
Home-page: https://github.com/Lightning-AI/utilities
Download-URL: https://github.com/Lightning-AI/utilities
Author: Lightning AI et al.
Author-email: pytorch@lightning.ai
License: Apache-2.0
Project-URL: Bug Tracker, https://github.com/Lightning-AI/utilities/issues
Project-URL: Documentation, https://dev-toolbox.rtfd.io/en/latest/
Project-URL: Source Code, https://github.com/Lightning-AI/utilities
Keywords: Utilities,DevOps,CI/CD
Classifier: Environment :: Console
Classifier: Natural Language :: English
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: importlib-metadata>=4.0.0; python_version < "3.8"
Requires-Dist: packaging>=17.1
Requires-Dist: setuptools
Requires-Dist: typing_extensions
Provides-Extra: typing
Requires-Dist: mypy>=1.0.0; extra == "typing"
Requires-Dist: types-setuptools; extra == "typing"
Requires-Dist: fire; extra == "typing"
Provides-Extra: cli
Requires-Dist: fire; extra == "cli"
Provides-Extra: docs
Requires-Dist: requests>=2.0.0; extra == "docs"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: download-url
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary
# Lightning Utilities
[](https://badge.fury.io/py/lightning-utilities)
[](https://github.com/Lightning-AI/utilities/blob/master/LICENSE)
[](https://pepy.tech/project/lightning-utilities)
[](https://pypi.org/project/lightning-utilities/)
[](https://github.com/Lightning-AI/utilities/actions/workflows/ci-testing.yml)
[](https://github.com/Lightning-AI/utilities/actions/workflows/ci-use-checks.yaml)
[](https://lit-utilities.readthedocs.io/en/latest/?badge=latest)
[](https://results.pre-commit.ci/latest/github/Lightning-AI/utilities/main)
__This repository covers the following use-cases:__
1. _Reusable GitHub workflows_
2. _Shared GitHub actions_
3. _General Python utilities in `lightning_utilities.core`_
4. _CLI `python -m lightning_utilities.cli --help`_
## 1. Reusable workflows
__Usage:__
```yaml
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](https://github.com/Lightning-AI/utilities/tree/main/.github/workflows/ci-use-checks.yaml).
## 2. Reusable composite actions
See available composite actions [.github/actions/](https://github.com/Lightning-AI/utilities/tree/main/.github/actions).
__Usage:__
```yaml
name: Do something with cache
on: [push]
jobs:
pytest:
runs-on: ubuntu-24.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. General Python utilities `lightning_utilities.core`
<details>
<summary>Installation</summary>
From source:
```bash
pip install https://github.com/Lightning-AI/utilities/archive/refs/heads/main.zip
```
From pypi:
```bash
pip install lightning_utilities
```
</details>
__Usage:__
Example for optional imports:
```python
from lightning_utilities.core.imports import module_available
if module_available("some_package.something"):
from some_package import something
```
## 4. CLI `lightning_utilities.cli`
The package provides common CLI commands.
<details>
<summary>Installation</summary>
From pypi:
```bash
pip install lightning_utilities[cli]
```
</details>
__Usage:__
```bash
python -m lightning_utilities.cli [group] [command]
```
<details>
<summary>Example for setting min versions</summary>
```console
$ 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
```
</details>
|