motor-python 0.0.4

Motor module for exosuit

Motor Control Software for Soft Exoskeleton

Install

To install the library run:

uv install motor_python

OR

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

"""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

uv run python -m motor_python

Testing

Unit Tests (No Hardware Required)

Run unit tests without hardware (using mocks):

make test          # Run unit tests only (no hardware required)
make test-hardware # Run hardware integration tests (requires motor connected)
make test-all      # Run all tests including hardware tests (full coverage)

Note: Hardware tests are skipped automatically if motor hardware is not available.

Structure

├── src
│   └── motor_python
│       ├── config
│       ├── __init__.py
│       ├── __main__.py
│       ├── cube_mars_motor.py
│       ├── definitions.py
│       ├── examples.py
│       ├── motor_status_parser.py
│       └── utils.py
├── tests
│   ├── __init__.py
│   ├── conftest.py
│   ├── cube_mars_motor_test.py
│   ├── hardware_test.py
│   ├── motor_status_parser_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