# 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**
1. **Shared GitHub actions**
1. **CLI `python -m lightning_utilities.cli --help`**
1. **General Python utilities in `lightning_utilities.core`**
## 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-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.
<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[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>
## 4. General Python utilities `lightning_utilities.core`
<details>
<summary>Installation</summary>
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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Lightning-AI/utilities",
"name": "lightning-utilities",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Utilities, DevOps, CI/CD",
"author": "Lightning AI et al.",
"author_email": "pytorch@lightning.ai",
"download_url": "https://files.pythonhosted.org/packages/91/e2/b18d85bab50dc26a43c0431a35c82b59e085b803d465eccf039ea415e993/lightning-utilities-0.11.2.tar.gz",
"platform": null,
"description": "# Lightning Utilities\n\n[](https://github.com/Lightning-AI/utilities/actions/workflows/ci-testing.yml)\n[](https://github.com/Lightning-AI/utilities/actions/workflows/ci-use-checks.yaml)\n[](https://lit-utilities.readthedocs.io/en/latest/?badge=latest)\n[](https://results.pre-commit.ci/latest/github/Lightning-AI/utilities/main)\n\n__This repository covers the following use-cases:__\n\n1. **Reusable GitHub workflows**\n1. **Shared GitHub actions**\n1. **CLI `python -m lightning_utilities.cli --help`**\n1. **General Python utilities in `lightning_utilities.core`**\n\n## 1. Reusable workflows\n\n__Usage:__\n\n```yaml\nname: Check schema\n\non: [push]\n\njobs:\n\n check-schema:\n uses: Lightning-AI/utilities/.github/workflows/check-schema.yml@v0.5.0\n with:\n azure-dir: \"\" # skip Azure check\n\n check-code:\n uses: Lightning-AI/utilities/.github/workflows/check-code.yml@main\n with:\n actions-ref: main # normally you shall use the same version as the workflow\n```\n\nSee 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).\n\n## 2. Reusable composite actions\n\nSee available composite actions [.github/actions/](https://github.com/Lightning-AI/utilities/tree/main/.github/actions).\n\n__Usage:__\n\n```yaml\nname: Do something with cache\n\non: [push]\n\njobs:\n pytest:\n runs-on: ubuntu-20.04\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-python@v4\n with:\n python-version: 3.9\n - uses: Lightning-AI/utilities/.github/actions/cache\n with:\n python-version: 3.9\n requires: oldest # or latest\n```\n\n## 3. CLI `lightning_utilities.cli`\n\nThe package provides common CLI commands.\n\n<details>\n <summary>Installation</summary>\nFrom source:\n\n```bash\npip install https://github.com/Lightning-AI/utilities/archive/refs/heads/main.zip\n```\n\nFrom pypi:\n\n```bash\npip install lightning_utilities[cli]\n```\n\n</details>\n\n__Usage:__\n\n```bash\npython -m lightning_utilities.cli [group] [command]\n```\n\n<details>\n <summary>Example for setting min versions</summary>\n\n```console\n$ cat requirements/test.txt\ncoverage>=5.0\ncodecov>=2.1\npytest>=6.0\npytest-cov\npytest-timeout\n$ python -m lightning_utilities.cli requirements set-oldest\n$ cat requirements/test.txt\ncoverage==5.0\ncodecov==2.1\npytest==6.0\npytest-cov\npytest-timeout\n```\n\n</details>\n\n## 4. General Python utilities `lightning_utilities.core`\n\n<details>\n <summary>Installation</summary>\n\nFrom pypi:\n\n```bash\npip install lightning_utilities\n```\n\n</details>\n\n__Usage:__\n\nExample for optional imports:\n\n```python\nfrom lightning_utilities.core.imports import module_available\n\nif module_available(\"some_package.something\"):\n from some_package import something\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Lightning toolbox for across the our ecosystem.",
"version": "0.11.2",
"project_urls": {
"Bug Tracker": "https://github.com/Lightning-AI/utilities/issues",
"Documentation": "https://dev-toolbox.rtfd.io/en/latest/",
"Download": "https://github.com/Lightning-AI/utilities",
"Homepage": "https://github.com/Lightning-AI/utilities",
"Source Code": "https://github.com/Lightning-AI/utilities"
},
"split_keywords": [
"utilities",
" devops",
" ci/cd"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5e9ee7768a8e363fc6f0c978bb7a0aa7641f10d80be60000e788ef2f01d34a7c",
"md5": "d4483c2a14fbf9d2902674d76fd99707",
"sha256": "541f471ed94e18a28d72879338c8c52e873bb46f4c47644d89228faeb6751159"
},
"downloads": -1,
"filename": "lightning_utilities-0.11.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d4483c2a14fbf9d2902674d76fd99707",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 26320,
"upload_time": "2024-03-27T23:51:39",
"upload_time_iso_8601": "2024-03-27T23:51:39.007821Z",
"url": "https://files.pythonhosted.org/packages/5e/9e/e7768a8e363fc6f0c978bb7a0aa7641f10d80be60000e788ef2f01d34a7c/lightning_utilities-0.11.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "91e2b18d85bab50dc26a43c0431a35c82b59e085b803d465eccf039ea415e993",
"md5": "33a4752fc136fcb294fe0799b180e76b",
"sha256": "adf4cf9c5d912fe505db4729e51d1369c6927f3a8ac55a9dff895ce5c0da08d9"
},
"downloads": -1,
"filename": "lightning-utilities-0.11.2.tar.gz",
"has_sig": false,
"md5_digest": "33a4752fc136fcb294fe0799b180e76b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 27600,
"upload_time": "2024-03-27T23:51:40",
"upload_time_iso_8601": "2024-03-27T23:51:40.703285Z",
"url": "https://files.pythonhosted.org/packages/91/e2/b18d85bab50dc26a43c0431a35c82b59e085b803d465eccf039ea415e993/lightning-utilities-0.11.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 23:51:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Lightning-AI",
"github_project": "utilities",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lightning-utilities"
}
JSON
