client library for the rerobots API
Python client library for the rerobots API
Releases are available at PyPI.
Documentation of the current release is at https://rerobots-py.readthedocs.io/ or can be built from sources as described below.
To install the current release, try
pip install rerobots
Check that the package is installed:
python -c 'import rerobots'
Most interesting interactions with rerobots require an API token, which can be provided through the environment variable REROBOTS_API_TOKEN.
For additional features, such as getting images from cameras as NumPy arrays,
pip install rerobots[extra]
Testing and development
A Git LFS client is required to clone this repository. Note that git clone will succeed without git lfs available, but some large files will not be fetched.
All tests are in the directory tests/. If you have the rerobots package installed, then you can
Several other commands are available to run subsets of tests or create coverage reports. For example, to run tests that do not touch production servers:
and to measure code coverage: make checklocalcover. To view the coverage report, direct your Web browser at tests/cover/index.html
To build the User’s Guide:
and direct your Web browser at doc/build/index.html
There are extra tests (not run during make check) that interact with production servers in a way that requires an API token and that may cause billing against the associated user account. These tests are only of interest if you plan to contribute internal changes to this Python package.
All participation must follow our code of conduct, elaborated in the file CODE_OF_CONDUCT.md in the same directory as this README.
Reporting errors, requesting features
Reports of security flaws are given the highest priority and should be sent to <firstname.lastname@example.org>, optionally encrypted with the public key available at https://rerobots.net/contact Please do so before opening a public issue to allow us an opportunity to find a fix.
Contributing changes or new code
Contributions are welcome! There is no formal declaration of code style. Just try to follow the style and structure currently in the repository.
Contributors, who are not rerobots employees, must agree to the Developer Certificate of Origin. Your agreement is indicated explicitly in commits by adding a Signed-off-by line with your real name. (This can be done automatically using git commit --signoff.)
This is free software, released under the Apache License, Version 2.0. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.