enable package description (#42)

Author: Borda

.github/workflows/ci-checks.yml

@@ -40,4 +40,4 @@ jobs:
   check-docs:
     uses: Lightning-AI/utilities/.github/workflows/check-docs.yml@main
     with:
-      requirements-file: "_requirements/docs.txt"
+      requirements-file: "_requirements/_docs.txt"

.github/workflows/docs-build.yml

@@ -8,7 +8,7 @@ jobs:
   build-docs:
     uses: Lightning-AI/utilities/.github/workflows/check-docs.yml@main
     with:
-      requirements-file: "_requirements/docs.txt"
+      requirements-file: "_requirements/_docs.txt"
 
   # https://github.com/marketplace/actions/deploy-to-github-pages
   docs-deploy:

.github/workflows/release-pypi.yml

@@ -11,18 +11,15 @@ on: # Trigger the workflow on push or pull request, but only for the main branch
 
 jobs:
   build:
-    runs-on: ubuntu-latest
-
+    runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: "3.10"
 
       - name: Install dependencies
-        run: pip install -U build twine
-      - name: Overview Readme for release
-        run: echo "# Lit Models" > README.md
+        run: pip install -U -r _requirements/_ci.txt
       - name: Build package
         run: python -m build
       - name: Check package

.readthedocs.yml

@@ -17,4 +17,4 @@ formats: all
 python:
   version: 3.7
   install:
-    - requirements: _requirements/docs.txt
+    - requirements: _requirements/_docs.txt

_requirements/_ci.txt

@@ -0,0 +1,2 @@
+build ==1.2.*
+twine ==6.0.*

_requirements/docs.txt _requirements/_docs.txt

@@ -29,7 +29,7 @@ def _load_requirements(path_dir: str = _PATH_ROOT, file_name: str = "requirement
     readme = fopen.read()
 
 
-def _prepare_extras(requirements_dir: str = _PATH_REQUIRES, skip_files: tuple = ("devel.txt", "docs.txt")) -> dict:
+def _prepare_extras(requirements_dir: str = _PATH_REQUIRES, skip_files: tuple = ("devel.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]`
@@ -38,7 +38,8 @@ def _prepare_extras(requirements_dir: str = _PATH_REQUIRES, skip_files: tuple =
     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
+        # ignore some development specific requirements
+        if p.name not in skip_files and not p.name.startswith("_")
     }
     # todo: eventually add some custom aggregations such as `develop`
     extras = {name: sorted(set(reqs)) for name, reqs in extras.items()}
@@ -96,5 +97,7 @@ def _prepare_extras(requirements_dir: str = _PATH_REQUIRES, skip_files: tuple =
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
     ],
 )

setup.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.0"
+__version__ = "0.1.0.post0"
 __author__ = "Lightning-AI et al."
 __author_email__ = "community@lightning.ai"
 __license__ = "Apache-2.0"