Skip to main content

client library for the rerobots API

Project description

Summary

command-line interface and 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.

Getting started

To install the current release, try

pip install rerobots

Besides installing the rerobots Python package, this will add the command rerobots to your shell. To get a brief help message, try

rerobots help

Most interesting interactions with rerobots require an API token, which can be provided through the environment variable REROBOTS_API_TOKEN or via the command-line switch -t.

For additional features, such as getting images from cameras as NumPy arrays,

pip install rerobots[extra]

Testing and development

All tests are in the directory tests/. If you have the rerobots package installed, then you can

make check

to run static analysis and tests that do not require a rerobots API token. Recent results on Travis CI are available at https://travis-ci.org/rerobots/py

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:

make checklocal

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:

make doc

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.

Participating

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

Please first check for prior reports that are similar or related in the issue tracker at https://github.com/rerobots/py/issues If your observations are indeed new, please open a new issue

Reports of security flaws are given the highest priority and should be sent to <security@rerobots.net>, 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.)

License

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rerobots-0.10.0.tar.gz (19.2 kB view details)

Uploaded Source

File details

Details for the file rerobots-0.10.0.tar.gz.

File metadata

  • Download URL: rerobots-0.10.0.tar.gz
  • Upload date:
  • Size: 19.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.24.0 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.9

File hashes

Hashes for rerobots-0.10.0.tar.gz
Algorithm Hash digest
SHA256 f5fce9ce489eb1920869943d62a22ecad529732cc997b884034fbb4683ce8c09
MD5 c219a88950fe2cbd285a4955fda8e620
BLAKE2b-256 7dd92c8b2b32a75c2e2e4c7ec13fefd93acee56ffcfdabcfba73a157179a9265

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page