Rename lightning_utilities.dev to lightning_utilities.cli (#46)

Rename dev to cli

.github/workflows/ci-testing.yml

@@ -29,8 +29,8 @@ jobs:
     - name: Set oldest dependencies
       if: matrix.requires == 'oldest'
       run: |
-        pip install -e '.[dev]'
-        python -m lightning_utilities.dev requirements set-oldest
+        pip install -e '.[cli]'
+        python -m lightning_utilities.cli requirements set-oldest
 
     - uses: ./.github/actions/cache
       with:

Makefile

@@ -6,7 +6,7 @@ export SLURM_LOCALID=0
 export SPHINX_MOCK_REQUIREMENTS=0
 
 test:
-	pip install -q -r requirements/dev.txt
+	pip install -q -r requirements/cli.txt
 	pip install -q -r requirements/test.txt
 
 	# use this to run tests

README.md

@@ -9,7 +9,7 @@ __This repository covers the following use-cases:__
 
 1. **GitHub workflows**
 1. **GitHub actions**
-1. **CLI `lightning_utilities.dev`**
+1. **CLI `lightning_utilities.cli`**
 1. **General Python utilities in `lightning_utilities.core`**
 
 ## 1. Reusable workflows
@@ -56,7 +56,7 @@ jobs:
         # requires: latest
 ```
 
-## 3. CLI `lightning_utilities.dev`
+## 3. CLI `lightning_utilities.cli`
 
 The package provides common CLI commands.
 
@@ -71,15 +71,15 @@ pip install https://github.com/Lightning-AI/utilities/archive/refs/heads/main.zi
 From pypi:
 
 ```bash
-pip install lightning_utilities[dev]
+pip install lightning_utilities[cli]
 ```
 
 </details>
 
 __Usage:__
 
 ```bash
-python -m lightning_utilities.dev [group] [command]
+python -m lightning_utilities.cli [group] [command]
 ```
 
 <details>
@@ -92,7 +92,7 @@ codecov>=2.1
 pytest>=6.0
 pytest-cov
 pytest-timeout
-$ python -m lightning_utilities.dev requirements set-oldest
+$ python -m lightning_utilities.cli requirements set-oldest
 $ cat requirements/test.txt
 coverage==5.0
 codecov==2.1

docs/source/conf.py

@@ -295,7 +295,7 @@ def _package_list_from_file(file):
 MOCK_PACKAGES = []
 if SPHINX_MOCK_REQUIREMENTS:
     # mock also base packages when we are on RTD since we don't install them there
-    MOCK_PACKAGES += _package_list_from_file(os.path.join(_PATH_ROOT, "requirements", "dev.txt"))
+    MOCK_PACKAGES += _package_list_from_file(os.path.join(_PATH_ROOT, "requirements", "cli.txt"))
 MOCK_PACKAGES = [PACKAGE_MAPPING.get(pkg, pkg) for pkg in MOCK_PACKAGES]
 
 autodoc_mock_imports = MOCK_PACKAGES

setup.py

@@ -19,8 +19,8 @@ def _load_py_module(fname, pkg="lightning_utilities"):
 
 
 about = _load_py_module("__about__.py")
-with open(os.path.join(_PATH_REQUIRE, "dev.txt")) as fp:
-    requirements_dev = list(map(str, parse_requirements(fp.readline())))
+with open(os.path.join(_PATH_REQUIRE, "cli.txt")) as fp:
+    requirements_cli = list(map(str, parse_requirements(fp.readline())))
 with open(os.path.join(_PATH_ROOT, "README.md")) as fp:
     readme = fp.read()
 
@@ -44,7 +44,7 @@ def _load_py_module(fname, pkg="lightning_utilities"):
     setup_requires=[],
     install_requires=[],
     extras_require={
-        "dev": requirements_dev,
+        "cli": requirements_cli,
     },
     project_urls={
         "Bug Tracker": "https://github.com/Lightning-AI/utilities/issues",

src/lightning_utilities/dev/__main__.py → src/lightning_utilities/cli/__main__.py

@@ -4,7 +4,7 @@
 #
 import fire
 
-from lightning_utilities.dev.dependencies import prune_pkgs_in_requirements, replace_oldest_ver
+from lightning_utilities.cli.dependencies import prune_pkgs_in_requirements, replace_oldest_ver
 
 
 def main() -> None:

tests/unittests/dev/test_dependencies.py → tests/unittests/cli/test_dependencies.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from lightning_utilities.dev.dependencies import prune_pkgs_in_requirements, replace_oldest_ver
+from lightning_utilities.cli.dependencies import prune_pkgs_in_requirements, replace_oldest_ver
 
 _PATH_ROOT = Path(__file__).parent.parent.parent