Add core and dev directories (#28)

Co-authored-by: Akihiro Nitta <nitta@akihironitta.com>
Lightning-AI · Sep 3, 2022 · 77410b3 · 77410b3
1 parent 6179395
commit 77410b3
Show file tree

Hide file tree

Showing 11 changed files with 10 additions and 7 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -18,3 +18,6 @@
 
 /.github/CODEOWNERS           @borda
 /setup.py                     @borda
+
+/src/lightning_utilities/core @borda @carmocca
+/tests/unittests/core         @borda @carmocca
diff --git a/.github/workflows/ci-testing.yml b/.github/workflows/ci-testing.yml
@@ -30,7 +30,7 @@ jobs:
       if: matrix.requires == 'oldest'
       run: |
         pip install -e .
-        python -m lightning_utilities requirements set-oldest
+        python -m lightning_utilities.dev requirements set-oldest
 
     - uses: ./.github/actions/cache
       with:

diff --git a/README.md b/README.md
@@ -79,7 +79,7 @@ pip install lightning_utilities
 __Usage:__
 
 ```bash
-python -m lightning_utilities [group] [command]
+python -m lightning_utilities.dev [group] [command]
 ```
 
 <details>
@@ -92,7 +92,7 @@ codecov>=2.1
 pytest>=6.0
 pytest-cov
 pytest-timeout
-$ python -m lightning_utilities requirements set-oldest
+$ python -m lightning_utilities.dev requirements set-oldest
 $ cat requirements/test.txt
 coverage==5.0
 codecov==2.1

diff --git a/setup.py b/setup.py
@@ -39,7 +39,7 @@ def _load_py_module(fname, pkg="lightning_utilities"):
     long_description_content_type="text/markdown",
     include_package_data=True,
     zip_safe=False,
-    keywords=["DevOps", "CI/CD"],
+    keywords=["Utilities", "DevOps", "CI/CD"],
     python_requires=">=3.7",
     setup_requires=[],
     install_requires=requirements,

diff --git a/src/lightning_utilities/core/__init__.py b/src/lightning_utilities/core/__init__.py
diff --git a/src/lightning_utilities/imports.py → src/lightning_utilities/core/imports.py b/src/lightning_utilities/imports.py → src/lightning_utilities/core/imports.py
diff --git a/src/lightning_utilities/dev/__init__.py b/src/lightning_utilities/dev/__init__.py
diff --git a/src/lightning_utilities/__main__.py → src/lightning_utilities/dev/__main__.py b/src/lightning_utilities/__main__.py → src/lightning_utilities/dev/__main__.py
@@ -1,6 +1,6 @@
 import fire
 
-from lightning_utilities.dependencies import prune_pkgs_in_requirements, replace_oldest_ver
+from lightning_utilities.dev.dependencies import prune_pkgs_in_requirements, replace_oldest_ver
 
 
 def main() -> None:

diff --git a/src/lightning_utilities/dependencies.py → src/lightning_utilities/dev/dependencies.py b/src/lightning_utilities/dependencies.py → src/lightning_utilities/dev/dependencies.py
diff --git a/tests/unittests/test_imports.py → tests/unittests/core/test_imports.py b/tests/unittests/test_imports.py → tests/unittests/core/test_imports.py
@@ -1,6 +1,6 @@
 import operator
 
-from lightning_utilities.imports import compare_version, module_available, RequirementCache
+from lightning_utilities.core.imports import compare_version, module_available, RequirementCache
 
 
 def test_module_exists():

diff --git a/tests/unittests/test_dependencies.py → tests/unittests/dev/test_dependencies.py b/tests/unittests/test_dependencies.py → tests/unittests/dev/test_dependencies.py
@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from lightning_utilities.dependencies import prune_pkgs_in_requirements, replace_oldest_ver
+from lightning_utilities.dev.dependencies import prune_pkgs_in_requirements, replace_oldest_ver
 
 _PATH_ROOT = Path(__file__).parent.parent.parent