lightning-sdk 0.0.0.dev0__tar.gz

lightning-sdk-0.0.0.dev0/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased] - YYYY-MM-DD
+
+### Added
+
+### Changed
+
+### Fixed
+
+### Removed
+
+### Deprecated

lightning-sdk-0.0.0.dev0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021-2023 Lightning-AI team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

lightning-sdk-0.0.0.dev0/MANIFEST.in

@@ -0,0 +1,42 @@
+# Manifest syntax https://docs.python.org/2/distutils/sourcedist.html
+graft wheelhouse
+
+recursive-exclude __pycache__  *.py[cod] *.orig
+
+# Include the README and CHANGELOG
+include *.md
+recursive-include src *.md
+
+# Include the license file
+include LICENSE
+
+# Exclude build configs
+exclude *.sh
+exclude *.toml
+exclude *.svg
+exclude *.yml
+exclude *.yaml
+
+# exclude tests from package
+recursive-exclude tests *
+recursive-exclude site *
+exclude tests
+
+# Exclude the documentation files
+recursive-exclude docs *
+exclude docs
+
+# Include the Requirements
+include requirements.txt
+recursive-include _requirements *.tx;t
+
+# Exclude Makefile
+exclude Makefile
+
+prune .git
+prune .github
+prune .circleci
+prune notebook*
+prune temp*
+prune test*
+prune benchmark*

lightning-sdk-0.0.0.dev0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.1
+Name: lightning-sdk
+Version: 0.0.0.dev0
+Summary: PyTorch Lightning Sample project.
+Home-page: https://github.com/Lightning-AI/lightning-sandbox
+Download-URL: https://github.com/Lightning-AI/lightning-sandbox
+Author: Lightning-AI et al.
+Author-email: community@lightning.ai
+License: Apache-2.0
+Project-URL: Bug Tracker, https://github.com/Lightning-AI/lightning-sandbox/issues
+Project-URL: Documentation, https://lightning-ai.github.io/lightning-sandbox/
+Project-URL: Source Code, https://github.com/Lightning-AI/lightning-sandbox
+Keywords: deep learning,pytorch,AI
+Classifier: Environment :: Console
+Classifier: Natural Language :: English
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: License :: OSI Approved :: Apache Software License
+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
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torch>=2.0.0
+Requires-Dist: lightning>=2.0.0
+Provides-Extra: test
+Requires-Dist: coverage>=5.0; extra == "test"
+Requires-Dist: mypy==1.5.1; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest>=6.0; extra == "test"
+
+# Lightning Sample project/package
+
+This is starter project template which shall simplify initial steps for each new PL project...
+
+[![lightning](https://img.shields.io/badge/-Lightning_2.0+-792ee5?logo=pytorchlightning&logoColor=white)](https://lightning.ai/)
+[![CI testing](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-testing.yml/badge.svg?event=push)](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-testing.yml)
+[![General checks](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-checks.yml/badge.svg?event=push)](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-checks.yml)
+[![Documentation Status](https://readthedocs.org/projects/lightning-sandbox/badge/?version=latest)](https://lightning-sandbox.readthedocs.io/en/latest/?badge=latest)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Lightning-AI/lightning-sandbox/main.svg?badge_token=mqheL1-cTn-280Vx4cJUdg)](https://results.pre-commit.ci/latest/github/Lightning-AI/lightning-sandbox/main?badge_token=mqheL1-cTn-280Vx4cJUdg)
+
+\* the Read-The-Docs is failing as this one leads to the public domain which requires the repo to be public too
+
+## Included
+
+Listing the implemented sections:
+
+- sample package named `pl_sandbox`
+- setting [CI](https://github.com/Lightning-AI/lightning-sandbox/actions?query=workflow%3A%22CI+testing%22) for package and _tests_ folder
+- setup/install package
+- setting docs with Sphinx
+- automatic PyPI release on GH release
+- Docs deployd as [GH pages](https://Lightning-AI.github.io/lightning-sandbox)
+- Makefile for building docs with `make docs` and run all tests `make test`
+
+## To be Done aka cross-check
+
+You still need to enable some external integrations such as:
+
+- [ ] rename `pl_<sandbox>` to anu other name, simple find-replace shall work well
+- [ ] update path used in the badges to the repository
+- [ ] lock the main breach in GH setting - no direct push without PR
+- [ ] set `gh-pages` as website and _docs_ as source folder in GH setting
+- [ ] init Read-The-Docs (add this new project)
+- [ ] add credentials for releasing package to PyPI
+- [ ] specify license in `LICENSE` file and package init
+
+## Tests / Docs notes
+
+- We are using [Napoleon style,](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html) and we shall use static types...
+- It is nice to se [doctest](https://docs.python.org/3/library/doctest.html) as they are also generated as examples in documentation
+- For wider and edge cases testing use [pytest parametrization](https://docs.pytest.org/en/stable/parametrize.html) :\]

lightning-sdk-0.0.0.dev0/README.md

@@ -0,0 +1,41 @@
+# Lightning Sample project/package
+
+This is starter project template which shall simplify initial steps for each new PL project...
+
+[![lightning](https://img.shields.io/badge/-Lightning_2.0+-792ee5?logo=pytorchlightning&logoColor=white)](https://lightning.ai/)
+[![CI testing](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-testing.yml/badge.svg?event=push)](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-testing.yml)
+[![General checks](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-checks.yml/badge.svg?event=push)](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-checks.yml)
+[![Documentation Status](https://readthedocs.org/projects/lightning-sandbox/badge/?version=latest)](https://lightning-sandbox.readthedocs.io/en/latest/?badge=latest)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Lightning-AI/lightning-sandbox/main.svg?badge_token=mqheL1-cTn-280Vx4cJUdg)](https://results.pre-commit.ci/latest/github/Lightning-AI/lightning-sandbox/main?badge_token=mqheL1-cTn-280Vx4cJUdg)
+
+\* the Read-The-Docs is failing as this one leads to the public domain which requires the repo to be public too
+
+## Included
+
+Listing the implemented sections:
+
+- sample package named `pl_sandbox`
+- setting [CI](https://github.com/Lightning-AI/lightning-sandbox/actions?query=workflow%3A%22CI+testing%22) for package and _tests_ folder
+- setup/install package
+- setting docs with Sphinx
+- automatic PyPI release on GH release
+- Docs deployd as [GH pages](https://Lightning-AI.github.io/lightning-sandbox)
+- Makefile for building docs with `make docs` and run all tests `make test`
+
+## To be Done aka cross-check
+
+You still need to enable some external integrations such as:
+
+- [ ] rename `pl_<sandbox>` to anu other name, simple find-replace shall work well
+- [ ] update path used in the badges to the repository
+- [ ] lock the main breach in GH setting - no direct push without PR
+- [ ] set `gh-pages` as website and _docs_ as source folder in GH setting
+- [ ] init Read-The-Docs (add this new project)
+- [ ] add credentials for releasing package to PyPI
+- [ ] specify license in `LICENSE` file and package init
+
+## Tests / Docs notes
+
+- We are using [Napoleon style,](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html) and we shall use static types...
+- It is nice to se [doctest](https://docs.python.org/3/library/doctest.html) as they are also generated as examples in documentation
+- For wider and edge cases testing use [pytest parametrization](https://docs.pytest.org/en/stable/parametrize.html) :\]

lightning-sdk-0.0.0.dev0/requirements.txt

@@ -0,0 +1,2 @@
+torch >=2.0.0
+lightning >=2.0.0

lightning-sdk-0.0.0.dev0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

lightning-sdk-0.0.0.dev0/setup.py

@@ -0,0 +1,100 @@
+#!/usr/bin/env python
+import glob
+import os
+from importlib.util import module_from_spec, spec_from_file_location
+from pathlib import Path
+
+from pkg_resources import parse_requirements
+from setuptools import find_packages, setup
+
+_PATH_ROOT = os.path.dirname(__file__)
+_PATH_SOURCE = os.path.join(_PATH_ROOT, "src")
+_PATH_REQUIRES = os.path.join(_PATH_ROOT, "_requirements")
+
+
+def _load_py_module(fname, pkg="pl_sandbox"):
+    spec = spec_from_file_location(os.path.join(pkg, fname), os.path.join(_PATH_SOURCE, pkg, fname))
+    py = module_from_spec(spec)
+    spec.loader.exec_module(py)
+    return py
+
+
+def _load_requirements(path_dir: str = _PATH_ROOT, file_name: str = "requirements.txt") -> list:
+    reqs = parse_requirements(open(os.path.join(path_dir, file_name)).readlines())
+    return list(map(str, reqs))
+
+
+about = _load_py_module("__about__.py")
+with open(os.path.join(_PATH_ROOT, "README.md"), encoding="utf-8") as fo:
+    readme = fo.read()
+
+
+def _prepare_extras(requirements_dir: str = _PATH_REQUIRES, skip_files: tuple = ("devel.txt", "docs.txt")) -> dict:
+    # https://setuptools.readthedocs.io/en/latest/setuptools.html#declaring-extras
+    # Define package extras. These are only installed if you specify them.
+    # From remote, use like `pip install pytorch-lightning[dev, docs]`
+    # From local copy of repo, use like `pip install ".[dev, docs]"`
+    req_files = [Path(p) for p in glob.glob(os.path.join(requirements_dir, "*.txt"))]
+    extras = {
+        p.stem: _load_requirements(file_name=p.name, path_dir=str(p.parent))
+        for p in req_files
+        if p.name not in skip_files
+    }
+    # todo: eventually add some custom aggregations such as `develop`
+    extras = {name: sorted(set(reqs)) for name, reqs in extras.items()}
+    print("The extras are: ", extras)
+    return extras
+
+
+# https://packaging.python.org/discussions/install-requires-vs-requirements /
+# keep the meta-data here for simplicity in reading this file... it's not obvious
+# what happens and to non-engineers they won't know to look in init ...
+# the goal of the project is simplicity for researchers, don't want to add too much
+# engineer specific practices
+setup(
+    name="lightning-sdk",
+    version=about.__version__,
+    description=about.__docs__,
+    author=about.__author__,
+    author_email=about.__author_email__,
+    url=about.__homepage__,
+    download_url="https://github.com/Lightning-AI/lightning-sandbox",
+    license=about.__license__,
+    packages=find_packages(where="src"),
+    package_dir={"": "src"},
+    long_description=readme,
+    long_description_content_type="text/markdown",
+    include_package_data=True,
+    zip_safe=False,
+    keywords=["deep learning", "pytorch", "AI"],
+    python_requires=">=3.8",
+    setup_requires=["wheel"],
+    install_requires=_load_requirements(),
+    extras_require=_prepare_extras(),
+    project_urls={
+        "Bug Tracker": "https://github.com/Lightning-AI/lightning-sandbox/issues",
+        "Documentation": "https://lightning-ai.github.io/lightning-sandbox/",
+        "Source Code": "https://github.com/Lightning-AI/lightning-sandbox",
+    },
+    classifiers=[
+        "Environment :: Console",
+        "Natural Language :: English",
+        # How mature is this project? Common values are
+        #   3 - Alpha, 4 - Beta, 5 - Production/Stable
+        "Development Status :: 3 - Alpha",
+        # Indicate who your project is intended for
+        "Intended Audience :: Developers",
+        "Topic :: Scientific/Engineering :: Artificial Intelligence",
+        "Topic :: Scientific/Engineering :: Information Analysis",
+        # Pick your license as you wish
+        "License :: OSI Approved :: Apache Software License",
+        "Operating System :: OS Independent",
+        # Specify the Python versions you support here. In particular, ensure
+        # that you indicate whether you support Python 2, Python 3 or both.
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+    ],
+)

lightning-sdk-0.0.0.dev0/src/lightning_sdk.egg-info/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.1
+Name: lightning-sdk
+Version: 0.0.0.dev0
+Summary: PyTorch Lightning Sample project.
+Home-page: https://github.com/Lightning-AI/lightning-sandbox
+Download-URL: https://github.com/Lightning-AI/lightning-sandbox
+Author: Lightning-AI et al.
+Author-email: community@lightning.ai
+License: Apache-2.0
+Project-URL: Bug Tracker, https://github.com/Lightning-AI/lightning-sandbox/issues
+Project-URL: Documentation, https://lightning-ai.github.io/lightning-sandbox/
+Project-URL: Source Code, https://github.com/Lightning-AI/lightning-sandbox
+Keywords: deep learning,pytorch,AI
+Classifier: Environment :: Console
+Classifier: Natural Language :: English
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: License :: OSI Approved :: Apache Software License
+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
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torch>=2.0.0
+Requires-Dist: lightning>=2.0.0
+Provides-Extra: test
+Requires-Dist: coverage>=5.0; extra == "test"
+Requires-Dist: mypy==1.5.1; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest>=6.0; extra == "test"
+
+# Lightning Sample project/package
+
+This is starter project template which shall simplify initial steps for each new PL project...
+
+[![lightning](https://img.shields.io/badge/-Lightning_2.0+-792ee5?logo=pytorchlightning&logoColor=white)](https://lightning.ai/)
+[![CI testing](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-testing.yml/badge.svg?event=push)](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-testing.yml)
+[![General checks](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-checks.yml/badge.svg?event=push)](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-checks.yml)
+[![Documentation Status](https://readthedocs.org/projects/lightning-sandbox/badge/?version=latest)](https://lightning-sandbox.readthedocs.io/en/latest/?badge=latest)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Lightning-AI/lightning-sandbox/main.svg?badge_token=mqheL1-cTn-280Vx4cJUdg)](https://results.pre-commit.ci/latest/github/Lightning-AI/lightning-sandbox/main?badge_token=mqheL1-cTn-280Vx4cJUdg)
+
+\* the Read-The-Docs is failing as this one leads to the public domain which requires the repo to be public too
+
+## Included
+
+Listing the implemented sections:
+
+- sample package named `pl_sandbox`
+- setting [CI](https://github.com/Lightning-AI/lightning-sandbox/actions?query=workflow%3A%22CI+testing%22) for package and _tests_ folder
+- setup/install package
+- setting docs with Sphinx
+- automatic PyPI release on GH release
+- Docs deployd as [GH pages](https://Lightning-AI.github.io/lightning-sandbox)
+- Makefile for building docs with `make docs` and run all tests `make test`
+
+## To be Done aka cross-check
+
+You still need to enable some external integrations such as:
+
+- [ ] rename `pl_<sandbox>` to anu other name, simple find-replace shall work well
+- [ ] update path used in the badges to the repository
+- [ ] lock the main breach in GH setting - no direct push without PR
+- [ ] set `gh-pages` as website and _docs_ as source folder in GH setting
+- [ ] init Read-The-Docs (add this new project)
+- [ ] add credentials for releasing package to PyPI
+- [ ] specify license in `LICENSE` file and package init
+
+## Tests / Docs notes
+
+- We are using [Napoleon style,](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html) and we shall use static types...
+- It is nice to se [doctest](https://docs.python.org/3/library/doctest.html) as they are also generated as examples in documentation
+- For wider and edge cases testing use [pytest parametrization](https://docs.pytest.org/en/stable/parametrize.html) :\]

lightning-sdk-0.0.0.dev0/src/lightning_sdk.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+CHANGELOG.md
+LICENSE
+MANIFEST.in
+README.md
+requirements.txt
+setup.py
+src/lightning_sdk.egg-info/PKG-INFO
+src/lightning_sdk.egg-info/SOURCES.txt
+src/lightning_sdk.egg-info/dependency_links.txt
+src/lightning_sdk.egg-info/not-zip-safe
+src/lightning_sdk.egg-info/requires.txt
+src/lightning_sdk.egg-info/top_level.txt
+src/pl_sandbox/__about__.py
+src/pl_sandbox/__init__.py
+src/pl_sandbox/my_module.py

lightning-sdk-0.0.0.dev0/src/lightning_sdk.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

lightning-sdk-0.0.0.dev0/src/lightning_sdk.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

lightning-sdk-0.0.0.dev0/src/lightning_sdk.egg-info/requires.txt

@@ -0,0 +1,8 @@
+torch>=2.0.0
+lightning>=2.0.0
+
+[test]
+coverage>=5.0
+mypy==1.5.1
+pytest-cov
+pytest>=6.0

lightning-sdk-0.0.0.dev0/src/lightning_sdk.egg-info/top_level.txt

@@ -0,0 +1 @@
+pl_sandbox

lightning-sdk-0.0.0.dev0/src/pl_sandbox/__about__.py

@@ -0,0 +1,17 @@
+__version__ = "0.0.0dev"
+__author__ = "Lightning-AI et al."
+__author_email__ = "community@lightning.ai"
+__license__ = "Apache-2.0"  # TODO: change if needed and update the LICENSE file
+__copyright__ = f"Copyright (c) 2020-2022, {__author__}."
+__homepage__ = "https://github.com/Lightning-AI/lightning-sandbox"
+__docs__ = "PyTorch Lightning Sample project."
+
+__all__ = [
+    "__author__",
+    "__author_email__",
+    "__copyright__",
+    "__docs__",
+    "__homepage__",
+    "__license__",
+    "__version__",
+]

lightning-sdk-0.0.0.dev0/src/pl_sandbox/__init__.py

@@ -0,0 +1,8 @@
+"""Root package info."""
+
+import os
+
+from pl_sandbox.__about__ import *  # noqa: F401, F403
+
+_PACKAGE_ROOT = os.path.dirname(__file__)
+_PROJECT_ROOT = os.path.dirname(_PACKAGE_ROOT)

lightning-sdk-0.0.0.dev0/src/pl_sandbox/my_module.py

@@ -0,0 +1,14 @@
+"""Sample..."""
+
+
+def my_sample_func(a: int, b: float) -> float:
+    """Sample function.
+
+    Doctest are good for creating examples in dcos and also hawing soma basic code coverage...
+
+    Example:
+        >>> my_sample_func(1, 1.5)
+        2.5
+
+    """
+    return a + b