Metadata-Version: 2.1
Name: lightning-utilities
Version: 0.6.0.post0
Summary: PyTorch Lightning Sample project.
Home-page: https://github.com/Lightning-AI/utilities
Author: Lightning AI et al.
Author-email: pytorch@lightning.ai
License: Apache-2.0
Download-URL: https://github.com/Lightning-AI/utilities
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
Description: # Lightning Utilities
        
        [![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)
        [![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)
        [![Documentation Status](https://readthedocs.org/projects/lightning_utilities/badge/?version=latest)](https://lightning-tools.readthedocs.io/en/latest/?badge=latest)
        [![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)
        
        __This repository covers the following use-cases:__
        
        1. **GitHub workflows**
        1. **GitHub actions**
        1. **CLI `lightning_utilities.cli`**
        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
        ```
        
Keywords: Utilities,DevOps,CI/CD
Platform: UNKNOWN
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.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: cli
Provides-Extra: docs
