rerobots 0.5.0

client library for the rerobots API

Summary

command-line interface and Python client library for the rerobots API

For more documentation, go to https://rerobots-py.readthedocs.io/

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

Testing and development

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

cd tests
python -m nose -v

Recent results on Travis CI are available at https://travis-ci.org/rerobots/py

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

Security disclosures are given the highest priority and should be sent to Scott <[e-mail]>, optionally encrypted with his public key. 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

http://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.