# Lightning Sample project/package
This is starter project template which shall simplify initial steps for each new PL project...
[](https://lightning.ai/)
[](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-testing.yml)
[](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-checks.yml)
[](https://lightning-sandbox.readthedocs.io/en/latest/?badge=latest)
[](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 `lit_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 deployed 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) :\]
Raw data
{
"_id": null,
"home_page": "https://github.com/Lightning-AI/lightning-sandbox",
"name": "thunderjit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "deep learning,pytorch,AI",
"author": "Lightning-AI et al.",
"author_email": "community@lightning.ai",
"download_url": "https://files.pythonhosted.org/packages/d8/79/070e17ccdebf2bc811cb5ad107d961b2fc53e2e5c0e23f435abdb23d1c24/thunderjit-0.0.0.dev0.tar.gz",
"platform": null,
"description": "# Lightning Sample project/package\n\nThis is starter project template which shall simplify initial steps for each new PL project...\n\n[](https://lightning.ai/)\n[](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-testing.yml)\n[](https://github.com/Lightning-AI/lightning-sandbox/actions/workflows/ci-checks.yml)\n[](https://lightning-sandbox.readthedocs.io/en/latest/?badge=latest)\n[](https://results.pre-commit.ci/latest/github/Lightning-AI/lightning-sandbox/main?badge_token=mqheL1-cTn-280Vx4cJUdg)\n\n\\* the Read-The-Docs is failing as this one leads to the public domain which requires the repo to be public too\n\n## Included\n\nListing the implemented sections:\n\n- sample package named `lit_sandbox`\n- setting [CI](https://github.com/Lightning-AI/lightning-sandbox/actions?query=workflow%3A%22CI+testing%22) for package and _tests_ folder\n- setup/install package\n- setting docs with Sphinx\n- automatic PyPI release on GH release\n- Docs deployed as [GH pages](https://Lightning-AI.github.io/lightning-sandbox)\n- Makefile for building docs with `make docs` and run all tests `make test`\n\n## To be Done aka cross-check\n\nYou still need to enable some external integrations such as:\n\n- [ ] rename `pl_<sandbox>` to anu other name, simple find-replace shall work well\n- [ ] update path used in the badges to the repository\n- [ ] lock the main breach in GH setting - no direct push without PR\n- [ ] set `gh-pages` as website and _docs_ as source folder in GH setting\n- [ ] init Read-The-Docs (add this new project)\n- [ ] add credentials for releasing package to PyPI\n- [ ] specify license in `LICENSE` file and package init\n\n## Tests / Docs notes\n\n- We are using [Napoleon style,](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html) and we shall use static types...\n- It is nice to se [doctest](https://docs.python.org/3/library/doctest.html) as they are also generated as examples in documentation\n- For wider and edge cases testing use [pytest parametrization](https://docs.pytest.org/en/stable/parametrize.html) :\\]\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "PyTorch Lightning Sample project.",
"version": "0.0.0.dev0",
"project_urls": {
"Bug Tracker": "https://github.com/Lightning-AI/lightning-sandbox/issues",
"Documentation": "https://lightning-ai.github.io/lightning-sandbox/",
"Download": "https://github.com/Lightning-AI/lightning-sandbox",
"Homepage": "https://github.com/Lightning-AI/lightning-sandbox",
"Source Code": "https://github.com/Lightning-AI/lightning-sandbox"
},
"split_keywords": [
"deep learning",
"pytorch",
"ai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "01bdb9835d5c1d27425ce8c8e639940f2dbf00599e39a7b3a5060a7c08207749",
"md5": "e5a9735257be80e39c368cd3d389437d",
"sha256": "18d221d7a115aec13ab7d8429ed187daf6ce600fed764e97e884fdd420e0b782"
},
"downloads": -1,
"filename": "thunderjit-0.0.0.dev0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e5a9735257be80e39c368cd3d389437d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7904,
"upload_time": "2024-03-08T19:33:32",
"upload_time_iso_8601": "2024-03-08T19:33:32.550756Z",
"url": "https://files.pythonhosted.org/packages/01/bd/b9835d5c1d27425ce8c8e639940f2dbf00599e39a7b3a5060a7c08207749/thunderjit-0.0.0.dev0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d879070e17ccdebf2bc811cb5ad107d961b2fc53e2e5c0e23f435abdb23d1c24",
"md5": "03b70859b1d5566bb2ae159efc4de578",
"sha256": "dcbca310113c3faca779bfa2c0f7c3d163fa554780c3489310f9add247f12c4d"
},
"downloads": -1,
"filename": "thunderjit-0.0.0.dev0.tar.gz",
"has_sig": false,
"md5_digest": "03b70859b1d5566bb2ae159efc4de578",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9115,
"upload_time": "2024-03-08T19:33:34",
"upload_time_iso_8601": "2024-03-08T19:33:34.742688Z",
"url": "https://files.pythonhosted.org/packages/d8/79/070e17ccdebf2bc811cb5ad107d961b2fc53e2e5c0e23f435abdb23d1c24/thunderjit-0.0.0.dev0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-08 19:33:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Lightning-AI",
"github_project": "lightning-sandbox",
"github_not_found": true,
"lcname": "thunderjit"
}
JSON
