Migrate to pyproject.toml and update project structure (#281)

* commit

* train: get version from toml instead of __init__

* fixup

* revert black to clarify pr

* Remove setup.py

* Test new build

* try again

* gitignore

* get version a different way

* Try again

* Try again

* tweak buildscript

* catch ffmpeg errors

Author: ksikka

.flake8

@@ -0,0 +1,6 @@
+[flake8]
+max-line-length = 88
+# E203: black conflict
+# E701: black conflict
+# F821: lot of issues regarding type annotations
+extend-ignore = E203,E701,F821

.gitignore

@@ -22,7 +22,6 @@ var/
 wheels/
 pip-wheel-metadata/
 share/python-wheels/
-*.egg-info/
 .installed.cfg
 *.egg
 MANIFEST
@@ -152,5 +151,5 @@ preds/
 scripts/.ipynb_checkpoints
 tb_logs
 tests/utils/test_cropzoom_data/
-tests/test_model_mirror_mouse/
-tests/test_model_mirror_mouse_multiview/
+tests/api/test_model_mirror_mouse/
+tests/api/test_model_mirror_mouse_multiview/

docs/source/api.rst

@@ -47,7 +47,7 @@ You create a model object using `Model.from_dir`:
 
 .. code-block:: python
 
-    from lightning_pose.model import Model
+    from lightning_pose.api.model import Model
 
     model = Model.from_dir("outputs/doc_model")
 
@@ -66,7 +66,7 @@ or:
 API Reference
 =============
 
-.. autoclass:: lightning_pose.model.Model
+.. autoclass:: lightning_pose.api.model.Model
     :members:
     :exclude-members: __init__, from_dir2
 

lightning_pose/__init__.py

@@ -1,8 +1,54 @@
-__version__ = "1.7.1"
-
 from pathlib import Path
 
 from omegaconf import OmegaConf
 
 LP_ROOT_PATH = (Path(__file__).parent.parent).absolute()
 OmegaConf.register_new_resolver("LP_ROOT_PATH", lambda: LP_ROOT_PATH)
+
+
+# Hacky way to get version from pypackage.toml.
+# Adapted from: https://github.com/python-poetry/poetry/issues/273#issuecomment-1877789967
+from typing import Any
+import importlib.metadata
+from pathlib import Path
+
+__package_version = "unknown"
+
+
+def __get_package_version() -> str:
+    """Find the version of this package."""
+    global __package_version
+
+    if __package_version != "unknown":
+        # We already set it at some point in the past,
+        # so return that previous value without any
+        # extra work.
+        return __package_version
+
+    try:
+        # Try to get the version of the current package if
+        # it is running from a distribution.
+        __package_version = importlib.metadata.version("lightning-pose")
+    except importlib.metadata.PackageNotFoundError:
+        # Fall back on getting it from a local pyproject.toml.
+        # This works in a development environment where the
+        # package has not been installed from a distribution.
+        import toml
+        import warnings
+
+        warnings.warn(
+            "lightning-pose not pip-installed, getting version from pyproject.toml."
+        )
+
+        pyproject_toml_file = Path(__file__).parent.parent / "pyproject.toml"
+        __package_version = toml.load(pyproject_toml_file)["project"]["version"]
+
+    return __package_version
+
+
+def __getattr__(name: str) -> Any:
+    """Get package attributes."""
+    if name in ("version", "__version__"):
+        return __get_package_version()
+    else:
+        raise AttributeError(f"No attribute {name} in module {__name__}.")