prepared repo with package for meta-api. README updated.

Author: larsrollik

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.3
+current_version = 0.0.1
 commit = True
 tag = True
 tag_name = {new_version}
@@ -27,6 +27,6 @@ replace = version = {new_version}
 search = Version: "{current_version}"
 replace = Version: "{new_version}"
 
-[bumpversion:file:templatepy/__init__.py]
+[bumpversion:file:sensapex_api/__init__.py]
 search = __version__ = "{current_version}"
 replace = __version__ = "{new_version}"

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ repos:
     hooks:
     -   id: reorder-python-imports
 -   repo: https://github.com/ambv/black
-    rev: 21.12b0
+    rev: 22.3.0
     hooks:
     - id: black
 -   repo: https://github.com/pre-commit/pre-commit-hooks

README.md

@@ -14,136 +14,54 @@
 
 [Zenodo]: https://zenodo.org
 
+[umsdk]: https://github.com/sensapex/umsdk
+[sensapex-py]: https://github.com/sensapex/sensapex-py
+
 [//]: # (Badges)
+[//]: # ([![DOI](https://zenodo.org/badge/370470893.svg)](https://zenodo.org/badge/latestdoi/370470893))
+[//]: # ([![PyPI](https://img.shields.io/pypi/v/templatepy.svg)](https://pypi.org/project/templatepy))
+[//]: # ([![Wheel](https://img.shields.io/pypi/wheel/templatepy.svg)](https://pypi.org/project/templatepy))
+[//]: # (![CI](https://github.com/larsrollik/sensapex_api/workflows/tests/badge.svg))
 
-[![Contributions](https://img.shields.io/badge/Contributions-Welcome-brightgreen.svg)](https://github.com/larsrollik/templatepy/blob/main/CONTRIBUTING.md)
-[![DOI](https://zenodo.org/badge/370470893.svg)](https://zenodo.org/badge/latestdoi/370470893)
-[![Website](https://img.shields.io/website?up_message=online&url=https%3A%2F%2Fgithub.com/larsrollik/templatepy)](https://github.com/larsrollik/templatepy)
-[![PyPI](https://img.shields.io/pypi/v/templatepy.svg)](https://pypi.org/project/templatepy)
-[![Wheel](https://img.shields.io/pypi/wheel/templatepy.svg)](https://pypi.org/project/templatepy)
-![CI](https://github.com/larsrollik/templatepy/workflows/tests/badge.svg)
+[![Contributions](https://img.shields.io/badge/Contributions-Welcome-brightgreen.svg)](https://github.com/larsrollik/sensapex_api/blob/main/CONTRIBUTING.md)
+[![Website](https://img.shields.io/website?up_message=online&url=https%3A%2F%2Fgithub.com/larsrollik/sensapex_api)](https://github.com/larsrollik/sensapex_api)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 
 
-# templatepy
-Template repo for python repositories & PyPi integration
+# sensapex-api
+Meta-API for Sensapex Manipulators from uMx family.
 ---
-**Version: "0.0.3"**
-
-
-## Usage
-1. **Change** files according to overview in `TODO` below
-2. **Develop** package...
-3. **Install** package:
-   - static/normal install: `pip install .`
-   - editable install:`pip install -e .`
-   - dev install: `pip install -e .[dev]` (some terminals require to escape brackets with ` \ ` as `\[`, esp. zsh)
-
-
-
-## File overview
-
-
-#### General
-- `LICENSE`: license text
-
-- `README.md`: [Github-flavored markdown] file
-
-- `templatepy`: placeholder folder for any python package that is configured for install via `setup.cfg` and `pyproject.toml`
-  - `__init__.py`: contains basic package info and example function that is called by console entrypoint (see `setup.cfg`)
-  - `example.data.file.config`: a file to demonstrate that data files are included based on `setup.cfg` criteria
-  - `example.data.file.test-extension-yu48`: a file to demonstrate data exclusion via `setup.py`
-
-
-#### Testing
-- `tests`: placeholder folder for unit/integration tests and associated data
-- `pytest.ini`: config for testing framework with `pytest` and `coverage` plugin (`pytest-cov`)
-
-
-#### Packaging system (see: [packaging] and [setup.cfg])
-  - `MANIFEST.in`: [manifest] file describes included/excluded files for build
+**Version: "0.0.1"**
 
-  - `pyproject.toml`:
-    - specifies build system: this replaces the usual `setup.py` architecture for setuptools
-    - config for [black] code formatter
+This is a meta-API for the Sensapex Python API, which is in turn a binding for the underlying C library.
 
-  - `setup.cfg`:
-    - package specification and install dependencies
-    - config for `flake8` formatting (see pre-commit)
+See underlying library and sources from Sensapex here:
+- [umsdk] library
+- [sensapex-py]
 
-  - `setup.py`: legacy file (see notes on new build-system below)
+## Functionality
+- Set relative zero position for one or all axes
+- Convenience methods to move signle axes (instead of giving vector for all axis, even if only intending to move one axis)
 
+-> See `examples` folder for usage of the relative positioning on one or all axes.
 
-#### Code maintenance (linting/formatting/github)
-- `.pre-commit-config.yaml`: use [pre-commit] to run code formatting (e.g. with [black] and `flake8`) and PEP compliance checks
-  - Install pre-commit hook with `pre-commit install` (Note: only installs it in the current virtual environment)
-  - Run it manually with `pre-commit run --all` or leave it to run on commit (requires to re-stage changed files!)
-
-- `.github`: folder that contains github automation workflows and issues templates
-
-- `.gitignore`: ignored files/folders in git tools
-
-- `.bumpversion.cfg`:  config for [bump2version]
-
-
-## TODO for **adapting** template to new project
-
-- [ ] Change package name:
-  - (1) `templatepy` folder
-  - (2) README.md
-  - (3) `name` argument in `setup.cfg`
-  - (4) `.github/workflows` files
-  - (5) `setup.cfg`: `[bumpversion:file:templatepy/__init__.py]`
-- [ ] Change details about project author, etc. in `setup.cfg`, `README.md`, and `templatepy/__init__.py`
-- [ ] Change license holder in `LICENSE`
-- [ ] Change `README` badge paths at top
-- [ ] Verify inclusions/exclusions of installable files/folders in `MANIFEST.in` and `setup.cfg`
-- [ ] Check `.gitignore` contains relevant criteria
-- [ ] Add all version string locations to `setup.cfg`/bump2version field.
-  - Use same syntax as for `[bumpversion:file:PACKAGEFOLDER/__init__.py]` line to describe how to find version on version increment
-- [ ] To upload to [pypi]: see below for workflow
-- [ ] To upload to [Zenodo] if repo is a publication:
-  - (1) Connect Zenodo to Github account
-  - (2) Flip switch on zenodo view of repo - **NOTE**: Zenodo can only copy from **public** repos
-  - (3) Create new release version of github repo (manual or via `.github/workflows/CI.yaml`)
-  - (4) Wait! Zenodo view with DOI assignment should update within about a minute
-  - (5) Add DOI badge to `README` file
-
-
-
-## Workflow for (automatically) uploading package to [pypi] or [test.pypi]
-- (1) On [pypi], make new API key for repo or general
-- (2) On [Github](https://github.com/larsrollik/templatepy/settings/secrets/actions/new), in repository settings add a new **actions secret** named `TWINE_API_KEY` and copy in the pypi API key
-- (3) Create a new [release](https://github.com/larsrollik/templatepy/releases/new) manually on github or by triggering the github workflow with a version without release extension (e.g. `x.y.z`)
-
-
-
-## Notes
-
-#### New(er) build system with `pyproject.toml` and `setup.cfg`
-- `pip`
-  - tested with `pip install .  --use-feature=in-tree-build` for forward-compatibility with `pip 21.3`
-  - keeping empty `setup.py` for enabling install in editable mode `-e` as this still requires such a file
-  - added `wheel` as build-system dependency for compatibility with pip that does not implement `PEP 517`
-- `setup.cfg`/`setup.py` might be fully replaced with `pyproject.toml`. [See this discussion](https://stackoverflow.com/questions/44878600/is-setup-cfg-deprecated) about [PEP-426](https://peps.python.org/pep-0426/), [PEP-517](https://peps.python.org/pep-0517), [PEP-518](https://peps.python.org/pep-0518)
+## Install
+1. Clone repo: `git clone https://github.com/larsrollik/sensapex-api.git`
+2. Install package: `pip install sensapex-api`
+3. Install sensapex UM SDK library
+   1. Follow method in original repo: [umsdk] library
+   2. or use version of `install_lib.sh` script (in this repo)
 
+## Dependencies
+- [sensapex-py] package that can be installed from [sensapex-py] or via `pip install sensapex`
+- [umsdk] library
 
 ## Contributing
 Contributions are very welcome!
 Please see the [contribution guidelines](https://github.com/larsrollik/templatepy/blob/main/CONTRIBUTING.md) or check out the [issues](https://github.com/larsrollik/templatepy/issues)
 
 ## License
-This software is released under the **[BSD 3-Clause License](https://github.com/larsrollik/templatepy/blob/main/LICENSE)**
-
-
-```shell
-wget -q -O tmp.zip http://dist.sensapex.com/misc/um-sdk/latest/umsdk-1_022-src.zip \
-    && unzip tmp.zip \
-    && rm tmp.zip \
-    && cd umsdk-1_022/src/lib/ \
-    && make -f Makefile.linux
-    
-sudo make -f Makefile.linux install
-echo $PWD
-```
+This software is released under the **[BSD 3-Clause License](https://github.com/larsrollik/templatepy/blob/main/LICENSE)**.
+
+This code is an abstraction layer on top of the MIT-licensed [sensapex-py] and the [umsdk].

examples/relative_zero_all_axes.py

@@ -0,0 +1,22 @@
+import logging
+import time
+
+from sensapex_api.manipulator import SensapexManipulator
+
+logging.getLogger().setLevel("DEBUG")
+
+
+def print_positions(s):
+    print("origin  ", s._relative_zero)
+    print("position", s.position)
+    print("relative", s.relative_zero)
+
+
+if __name__ == "__main__":
+    s = SensapexManipulator(device_id=1)
+    s.set_relative_zero_all()
+
+    print_positions(s)
+    s.set_axis_position_relative(-1, -2000, 500)
+    time.sleep(5)
+    print_positions(s)

examples/relative_zero_one_axis.py

@@ -0,0 +1,22 @@
+import logging
+import time
+
+from sensapex_api.manipulator import SensapexManipulator
+
+logging.getLogger().setLevel("DEBUG")
+
+
+def print_positions(s):
+    print("origin  ", s._relative_zero)
+    print("position", s.position)
+    print("relative", s.relative_zero)
+
+
+if __name__ == "__main__":
+    s = SensapexManipulator(device_id=1)
+    s.set_relative_zero_axis(-1)
+
+    print_positions(s)
+    s.set_axis_position_relative(-1, -2000, 500)
+    time.sleep(5)
+    print_positions(s)

install_lib.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+wget -q -O tmp.zip http://dist.sensapex.com/misc/um-sdk/latest/umsdk-1_022-src.zip \
+    && unzip tmp.zip \
+    && rm tmp.zip
+
+cd umsdk-1_022/src/lib/ \
+    && make -f Makefile.linux
+
+sudo make -f Makefile.linux install
+echo $PWD

pytest.ini

@@ -1,2 +1,2 @@
 [pytest]
-addopts = --cov=templatepy
+addopts = --cov=sensapex_api

sensapex-api/__init__.py

@@ -0,0 +1,5 @@
+__author__ = "Lars B. Rollik"
+__version__ = "0.0.1"
+
+
+from sensapex_api.cli import run_cli as run

sensapex_api/__init__.py

@@ -0,0 +1,9 @@
+from argparse import ArgumentParser
+
+
+def run_cli():
+    NotImplementedError("CLI not yet implemented")
+
+
+if __name__ == "__main__":
+    run_cli()