motor-python 0.0.2__py3-none-any.whl

motor_python/__init__.py

@@ -0,0 +1,3 @@
+"""Sample doc string."""
+
+__version__ = "0.0.2"

motor_python/__main__.py

@@ -0,0 +1,44 @@
+"""Sample doc string."""
+
+import argparse
+
+from loguru import logger
+
+from motor_python.definitions import DEFAULT_LOG_LEVEL, LogLevel
+from motor_python.utils import setup_logger
+
+
+def main(
+    log_level: str = DEFAULT_LOG_LEVEL, stderr_level: str = DEFAULT_LOG_LEVEL
+) -> None:
+    """Run the main pipeline.
+
+    :param log_level: The log level to use.
+    :param stderr_level: The std err level to use.
+    :return: None
+    """
+    setup_logger(log_level=log_level, stderr_level=stderr_level)
+    logger.info("Hello, world!")
+
+
+if __name__ == "__main__":  # pragma: no cover
+    parser = argparse.ArgumentParser("Run the pipeline.")
+    parser.add_argument(
+        "--log-level",
+        default=DEFAULT_LOG_LEVEL,
+        choices=list(LogLevel()),
+        help="Set the log level.",
+        required=False,
+        type=str,
+    )
+    parser.add_argument(
+        "--stderr-level",
+        default=DEFAULT_LOG_LEVEL,
+        choices=list(LogLevel()),
+        help="Set the std err level.",
+        required=False,
+        type=str,
+    )
+    args = parser.parse_args()
+
+    main(log_level=args.log_level)

motor_python/cube_mars_motor.py

@@ -0,0 +1,8 @@
+"""Sample doc string."""
+
+from loguru import logger
+
+
+def motor_v3() -> None:
+    """Run dummy code for the motor."""
+    logger.info("Hello, world!")

motor_python/defintions.py

@@ -0,0 +1,43 @@
+"""Common definitions for this module."""
+
+from dataclasses import asdict, dataclass
+from pathlib import Path
+
+import numpy as np
+
+np.set_printoptions(precision=3, floatmode="fixed", suppress=True)
+
+
+# --- Directories ---
+ROOT_DIR: Path = Path("src").parent
+DATA_DIR: Path = ROOT_DIR / "data"
+RECORDINGS_DIR: Path = DATA_DIR / "recordings"
+LOG_DIR: Path = DATA_DIR / "logs"
+
+# Default encoding
+ENCODING: str = "utf-8"
+
+DATE_FORMAT = "%Y-%m-%d_%H-%M-%S"
+
+DUMMY_VARIABLE = "dummy_variable"
+
+
+@dataclass
+class LogLevel:
+    """Log level."""
+
+    trace: str = "TRACE"
+    debug: str = "DEBUG"
+    info: str = "INFO"
+    success: str = "SUCCESS"
+    warning: str = "WARNING"
+    error: str = "ERROR"
+    critical: str = "CRITICAL"
+
+    def __iter__(self):
+        """Iterate over log levels."""
+        return iter(asdict(self).values())
+
+
+DEFAULT_LOG_LEVEL = LogLevel.info
+DEFAULT_LOG_FILENAME = "log_file"

motor_python/utils.py

@@ -0,0 +1,59 @@
+"""Configure the logger."""
+
+import sys
+from datetime import datetime
+from pathlib import Path
+
+from loguru import logger
+
+from motor_python.definitions import (
+    DATE_FORMAT,
+    DEFAULT_LOG_FILENAME,
+    DEFAULT_LOG_LEVEL,
+    ENCODING,
+    LOG_DIR,
+)
+
+
+def create_timestamped_filepath(suffix: str, output_dir: Path, prefix: str) -> Path:
+    """Generate a timestamped filename.
+
+    :param suffix: Suffix to append to the timestamped filename.
+    :param output_dir: Output directory.
+    :param prefix: Prefix to append to the timestamped filename.
+    :return: Path to the timestamped filename.
+    """
+    timestamp = datetime.now().strftime(DATE_FORMAT)
+    filepath = output_dir / f"{prefix}_{timestamp}.{suffix}"
+    filepath.parent.mkdir(parents=True, exist_ok=True)  # create dirs if missing
+    filepath.touch(exist_ok=True)  # create empty file (don't overwrite)
+    return filepath
+
+
+def setup_logger(
+    filename: str = DEFAULT_LOG_FILENAME,
+    stderr_level: str = DEFAULT_LOG_LEVEL,
+    log_level: str = DEFAULT_LOG_LEVEL,
+    log_dir: Path | None = None,
+) -> Path:
+    """Configure the logger.
+
+    :param filename: Name of the file to create.
+    :param stderr_level: Logging level to use.
+    :param log_level: Logging level to use.
+    :param log_dir: Logging directory to use.
+    :return: Path to the created logfile.
+    """
+    logger.remove()
+
+    if log_dir is None:
+        log_filepath = LOG_DIR
+    else:
+        log_filepath = log_dir
+    filepath_with_time = create_timestamped_filepath(
+        output_dir=log_filepath, prefix=filename, suffix="log"
+    )
+    logger.add(sys.stderr, level=stderr_level)
+    logger.add(filepath_with_time, level=log_level, encoding=ENCODING, enqueue=True)
+    logger.info(f"Logging to '{filepath_with_time}'.")
+    return filepath_with_time

motor_python-0.0.2.dist-info/METADATA

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: motor_python
+Version: 0.0.2
+Summary: Motor module for exosuit
+Project-URL: homepage, https://github.com/TUM-Aries-Lab/motor-module
+Author-email: Tsmorz <tony.smoragiewicz@tum.de>, Hannes <hannes.nguyen@tum.de>
+License-File: LICENSE
+Requires-Python: <3.14,>=3.11
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: numpy>=2.2.3
+Description-Content-Type: text/markdown
+
+# Motor Control Software for Soft Exoskeleton
+[![Coverage Status](https://coveralls.io/repos/github/TUM-Aries-Lab/motor-module/badge.svg?branch=main)](https://coveralls.io/github/TUM-Aries-Lab/motor-module?branch=main)
+![Docker Image CI](https://github.com/TUM-Aries-Lab/motor-module/actions/workflows/ci.yml/badge.svg)
+
+
+
+## Install
+To install the library run:
+
+```bash
+uv install motor_python
+```
+
+OR
+
+```bash
+uv install git+https://github.com/TUM-Aries-Lab/motor_python.git@<specific-tag>  
+```
+
+## Publishing
+It's super easy to publish your own packages on PyPI. To build and publish this package run:
+1. Update the version number in pyproject.toml and imu_module/__init__.py
+2. Commit your changes and add a git tag "<new.version.number>"
+3. Push the tag `git push --tag`
+
+The package can then be found at: https://pypi.org/project/motor_python
+
+## Module Usage
+```python
+"""Basic docstring for my module."""
+
+from loguru import logger
+
+from motor_python import definitions
+
+def main() -> None:
+    """Run a simple demonstration."""
+    logger.info("Hello World!")
+
+if __name__ == "__main__":
+    main()
+```
+
+## Program Usage
+```bash
+uv run python -m motor_python
+```
+
+## Structure
+<!-- TREE-START -->
+```
+├── src
+│   └── motor_python
+│       ├── __init__.py
+│       ├── __main__.py
+│       ├── cube_mars_motor.py
+│       ├── defintions.py
+│       └── utils.py
+├── tests
+│   ├── __init__.py
+│   ├── conftest.py
+│   ├── main_test.py
+│   └── utils_test.py
+├── .dockerignore
+├── .gitignore
+├── .pre-commit-config.yaml
+├── .python-version
+├── CONTRIBUTING.md
+├── Dockerfile
+├── LICENSE
+├── Makefile
+├── README.md
+├── pyproject.toml
+├── repo_tree.py
+└── uv.lock
+```
+<!-- TREE-END -->

motor_python-0.0.2.dist-info/RECORD

@@ -0,0 +1,9 @@
+motor_python/__init__.py,sha256=Qj1a01QckaNqIJr7l-KiIqE9uqgXNVkdrkjBaLoZFqA,48
+motor_python/__main__.py,sha256=ZQ5onJIoPOtu5EHZFg45g11-xdn9wb9zAy9eylZ9nD0,1111
+motor_python/cube_mars_motor.py,sha256=xuGWt4KcMOTbGtiODXR-HGkGLZ5FDxWINnKM9xAKtg8,151
+motor_python/defintions.py,sha256=84ktNPHBI63zKxScWpm-nmb8hnMzATi_1A1Z4ZQ8aWA,903
+motor_python/utils.py,sha256=Un4v-RiBLkqMzFwnI9XL2dwe3l6E_kU7lpMYvasfRBQ,1811
+motor_python-0.0.2.dist-info/METADATA,sha256=IVhknjVQuQFleBdLoJqDEjguRQgd7u43GHvS2weRH-I,2236
+motor_python-0.0.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+motor_python-0.0.2.dist-info/licenses/LICENSE,sha256=J_-eQzWwyPIh9eTZiUZaRO2IRicN-EQlYTMvlmYtdM0,1070
+motor_python-0.0.2.dist-info/RECORD,,

motor_python-0.0.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

motor_python-0.0.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 TUM Aries Lab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.