This project has been archived by its maintainers, and is no longer receiving any updates.
@wandelbots/wandelbots-python
This library provides a wrapper around the Wandelbots API. Under the hood it queries the API endpoints directly, not using wandelbots_api_client (which is still required as dependencies since the auto-generated types are used from the package for type-checking convenience).
The wrapper is meant to ease the interaction with the Wandelbots API by providing a simpler interface for initializing a MotionGroup and interacting with it.
For the full feature set of our API please refer to the official documentation and use the wandelbots_api_client package directly.
You can try the features of this library in a Jupyter notebook by clicking the Binder badge above. Create a new Instance by registering on the Wandelbots website and use the credentials to interact with the API.
Current Features:
- Sync and Async Planning and Execution
- Pose Transformations
Table Of Contents
Requirements
This library requires
- Python >=3.9
Installation
To use the library, first install it using the following command
pip install wandelbots
Then import the library in your code
from wandelbots import Instance, MotionGroup, Planner
Development
To install the development dependencies, run the following command
poetry install
To remove an old virtual environment and create a new one, first get the name of the old environment by running
poetry env info
Then remove the old environment and create a new one with the following commands
poetry env remove <name-of-env>
poetry install
Run the poetry shell to activate the virtual environment
poetry shell
Build
To build the package locally, run the following command
poetry build
This will create a dist/ directory with the built package (.tar.gz and .whl files).
Installation
pip install wandelbots
Install a development branch in Poetry
wandelbots = { git = "https://github.com/wandelbotsgmbh/wandelbots-python.git", branch = "feature/set-ios-on-path" }
Basic Usage
The wrapper provides a simple interface for initializing a Instance, MotionGroup and a Planner object, which can be used to interact with the Wandelbots API:
from wandelbots import Instance, MotionGroup, Planner
my_instance = Instance(
url=https://<my-instance-url>,
user=<username>,
password=<password>
)
my_robot = MotionGroup(
instance=my_instance,
cell="cell",
motion_group="0@motion_group",
default_tcp="Flange"
)
For further examples take a look at the examples.
Testing
poetry run pytest -rs -v
Integration Tests
By default integration tests will be skipped.
To run them localy create an env file at envs/.env.tests with your values.
WANDELAPI_BASE_URL=
NOVA_ACCESS_TOKEN=
CELL_ID=
MOTION_GROUP=
TCP=
Metadata
Release files for wandelbots 0.5.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| wandelbots-0.5.7.tar.gz | 19.0 kB | Without provenance | Details for wandelbots-0.5.7.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| wandelbots-0.5.7-py3-none-any.whl | Python 3 | none | any | Details for wandelbots-0.5.7-py3-none-any.whl |
Total release size: 44.2 kB
Release files / wandelbots-0.5.7.tar.gz
| Download URL | wandelbots-0.5.7.tar.gz |
|---|---|
| Size | 19.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a7b095b5d45a70bebcada15cc6ecff5863b68980f886adfefb58ceb3e3e83544
|
|
BLAKE2b-256 checksum How to use checksums |
5c15a5ed1fed908b9852b0329a4695b0635ebad79064d17060e34406ae401e75
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.28.1
|
Release files / wandelbots-0.5.7-py3-none-any.whl
| Download URL | wandelbots-0.5.7-py3-none-any.whl |
|---|---|
| Size | 25.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
824834d0c4ecccd2400b111795c92d604af5cfd63df7e3ec91e5fad9aba76b1e
|
|
BLAKE2b-256 checksum How to use checksums |
75a5af2ee0baf2ddc2ea64390191739e62362b5bb1dbc74e22a8f6d1d06bf0db
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.28.1
|
Security for wandelbots 0.5.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.