Package: rerobots
SummaryPython client library for the rerobots APIReleases are availableat PyPI.Documentation of the current release is athttps://rerobots-py.readthedocs.io/or can be built from sources as described below.Getting startedTo install the current release, trypip install rerobotsCheck 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 variableREROBOTS_API_TOKEN.For additional features, such as getting images from cameras as NumPy arrays,pip install rerobots[extra]Testing and developmentAGit LFSclient is required to clone this
repository. Note thatgit clonewill succeed withoutgit lfsavailable, but
some large files will not be fetched.All tests are in the directorytests/. If you have thererobotspackage
installed, then you canmake checkto run static analysis and tests that do not require a rerobots API token.
Recent results onTravis CIare available athttps://travis-ci.com/github/rerobots/pySeveral 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 checklocaland to measure code coverage:make checklocalcover. To view the coverage
report, direct your Web browser at tests/cover/index.htmlTo build the User’s Guide:make docand direct your Web browser at doc/build/index.htmlThere are extra tests (not run duringmake 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.ParticipatingAll 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 featuresPlease first check for prior reports that are similar or related in the issue
tracker athttps://github.com/rerobots/py/issuesIf your observations are indeed new, pleaseopen a new
issueReports of security flaws are given the highest priority and should be sent to
<security@rerobots.net>, optionally encrypted with the public key available athttps://rerobots.net/contactPlease do so before opening a public issue to allow
us an opportunity to find a fix.Contributing changes or new codeContributions 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 theDeveloper
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 usinggit commit--signoff.)LicenseThis is free software, released under the Apache License, Version 2.0.
You may obtain a copy of the License athttps://www.apache.org/licenses/LICENSE-2.0Unless 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.