{"author":"Lightning AI et al.","author_email":"pytorch@lightning.ai","bugtrack_url":null,"classifiers":["Development Status :: 3 - Alpha","Environment :: Console","Intended Audience :: Developers","Natural Language :: English","Operating System :: OS Independent","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9"],"description":"# Lightning Utilities\n\n[![PyPI Status](https://badge.fury.io/py/lightning-utilities.svg)](https://badge.fury.io/py/lightning-utilities)\n[![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/Lightning-AI/utilities/blob/master/LICENSE)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/lightning-utilities)](https://pepy.tech/project/lightning-utilities)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/lightning-utilities)](https://pypi.org/project/lightning-utilities/)\n\n[![UnitTests](https://github.com/Lightning-AI/utilities/actions/workflows/ci-testing.yml/badge.svg?event=push)](https://github.com/Lightning-AI/utilities/actions/workflows/ci-testing.yml)\n[![Apply checks](https://github.com/Lightning-AI/utilities/actions/workflows/ci-use-checks.yaml/badge.svg?event=push)](https://github.com/Lightning-AI/utilities/actions/workflows/ci-use-checks.yaml)\n[![Docs Status](https://readthedocs.org/projects/lit-utilities/badge/?version=latest)](https://lit-utilities.readthedocs.io/en/latest/?badge=latest)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Lightning-AI/utilities/main.svg)](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_\n2. _Shared GitHub actions_\n3. _General Python utilities in `lightning_utilities.core`_\n4. _CLI `python -m lightning_utilities.cli --help`_\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-24.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. General Python utilities `lightning_utilities.core`\n\n

Installation

\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\n```\n\n

\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\n## 4. CLI `lightning_utilities.cli`\n\nThe package provides common CLI commands.\n\n

Installation

\n\nFrom pypi:\n\n```bash\npip install lightning_utilities[cli]\n```\n\n

\n\n__Usage:__\n\n```bash\npython -m lightning_utilities.cli [group] [command]\n```\n\n

Example for setting min versions

\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

\n","description_content_type":"text/markdown","docs_url":null,"download_url":"https://github.com/Lightning-AI/utilities","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":["Author","Author-Email","Classifier","Description","Description-Content-Type","Download-Url","Home-Page","Keywords","License","License-File","Project-Url","Provides-Extra","Requires-Dist","Requires-Python","Summary"],"home_page":"https://github.com/Lightning-AI/utilities","keywords":"Utilities, DevOps, CI/CD","license":"Apache-2.0","license_expression":null,"license_files":["LICENSE"],"maintainer":null,"maintainer_email":null,"name":"lightning-utilities","package_url":"https://pypi.org/project/lightning-utilities/","platform":null,"project_url":"https://pypi.org/project/lightning-utilities/","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"},"provides_extra":["typing","cli","docs"],"release_url":"https://pypi.org/project/lightning-utilities/0.14.3/","requires_dist":["importlib-metadata>=4.0.0; python_version < \"3.8\"","packaging>=17.1","setuptools","typing_extensions","mypy>=1.0.0; extra == \"typing\"","types-setuptools; extra == \"typing\"","fire; extra == \"typing\"","fire; extra == \"cli\"","requests>=2.0.0; extra == \"docs\""],"requires_python":">=3.9","summary":"Lightning toolbox for across the our ecosystem.","version":"0.14.3","yanked":false,"yanked_reason":null}

Dependency	Optional
importlib-metadata	false
packaging	false
setuptools	false
typing_extensions	false
fire	true
mypy	true
requests	true
types-setuptools	true

Package search

lightning-utilities

project_urls

Dependencies

All package metadata

Releases