From d62384d391c975323a6a85d6ca508fabd715f9f1 Mon Sep 17 00:00:00 2001 From: Nicholas Nadeau Date: Sat, 21 Jan 2017 22:24:41 -0500 Subject: [PATCH] self-generate RST README as travis-ci uses precise (12.04LTS) which is limited to pandoc (1.9.1.1-1) which seems to be bugged --- .gitignore | 2 -- .travis.yml | 1 - README.rst | 96 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 96 insertions(+), 3 deletions(-) create mode 100644 README.rst diff --git a/.gitignore b/.gitignore index ae9f55a9..b3181f40 100644 --- a/.gitignore +++ b/.gitignore @@ -364,6 +364,4 @@ ENV/ .idea *.rej -README.rst -README VERSION diff --git a/.travis.yml b/.travis.yml index 3e81802c..d41b53cb 100644 --- a/.travis.yml +++ b/.travis.yml @@ -37,7 +37,6 @@ install: - pip install vulture - pip install bandit - pip install pypandoc -- python convert_readme.py - python update_version.py - pip install . - pip install -r requirements.txt diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..22f7e644 --- /dev/null +++ b/README.rst @@ -0,0 +1,96 @@ +|PyPI Version| |GitHub tag| |DOI| |PyPI License| + +|PyPI Downloads| |PyPI Wheel| |PyPI Format| |PyPI Pythons| |PyPI +Implementation| |PyPI Status| + +|Build Status| |CircleCI| + +|Dependency Status| |Coverage Status| |codecov| |Codacy Badge| |Code +Climate| |Issue Count| + +pybotics +======== + +Python Toolbox for Robotics + +Context +------- + +Inspired from `Peter Corke's Robotics +Toolbox `__ for MATLAB. +However, MATLAB is not necessarily widespread outside of academia (and I +prefer Python), thus Pybotics was born. + +Requirements/Compatibility +-------------------------- + +- `Python >= 3.4 `__ +- See `requirements.txt `__ for package dependencies + +Applications and Usage +---------------------- + +- `Kinematics `__ +- `Calibration `__ +- Trajectory and path planning + +Contributing +------------ + +1. Fork it! +2. Create your feature branch +3. Follow PEP 8 style guide +4. Don't break the current codebase (without good reason) +5. Have tests for all your code +6. Submit a pull request :D + +Limitations +----------- + +- Currently only supports `Modified Denavit–Hartenberg + Parameters `__ + +References +---------- + +- Craig, John J. Introduction to robotics: mechanics and control. Vol. + 3. Upper Saddle River: Pearson Prentice Hall, 2005. +- Corke, Peter. Robotics, vision and control: fundamental algorithms in + MATLAB. Vol. 73. Springer, 2011. + +.. |PyPI Version| image:: https://img.shields.io/pypi/v/pybotics.svg + :target: https://pypi.python.org/pypi/pybotics +.. |GitHub tag| image:: https://img.shields.io/github/tag/nnadeau/pybotics.svg?maxAge=2592000?style=flat-square + :target: https://github.com/nnadeau/pybotics/releases +.. |DOI| image:: https://zenodo.org/badge/66797360.svg + :target: https://zenodo.org/badge/latestdoi/66797360 +.. |PyPI License| image:: https://img.shields.io/pypi/l/pybotics.svg + :target: https://pypi.python.org/pypi/pybotics +.. |PyPI Downloads| image:: https://img.shields.io/pypi/dm/pybotics.svg + :target: https://pypi.python.org/pypi/pybotics +.. |PyPI Wheel| image:: https://img.shields.io/pypi/wheel/pybotics.svg + :target: https://pypi.python.org/pypi/pybotics +.. |PyPI Format| image:: https://img.shields.io/pypi/format/pybotics.svg + :target: https://pypi.python.org/pypi/pybotics +.. |PyPI Pythons| image:: https://img.shields.io/pypi/pyversions/pybotics.svg + :target: https://pypi.python.org/pypi/pybotics +.. |PyPI Implementation| image:: https://img.shields.io/pypi/implementation/pybotics.svg + :target: https://pypi.python.org/pypi/pybotics +.. |PyPI Status| image:: https://img.shields.io/pypi/status/pybotics.svg + :target: https://pypi.python.org/pypi/pybotics +.. |Build Status| image:: https://travis-ci.org/nnadeau/pybotics.svg?branch=master + :target: https://travis-ci.org/nnadeau/pybotics +.. |CircleCI| image:: https://circleci.com/gh/nnadeau/pybotics/tree/master.svg?style=svg + :target: https://circleci.com/gh/nnadeau/pybotics/tree/master +.. |Dependency Status| image:: https://www.versioneye.com/user/projects/57d87a4a7129660045cf3a58/badge.svg?style=flat-square + :target: https://www.versioneye.com/user/projects/57d87a4a7129660045cf3a58 +.. |Coverage Status| image:: https://coveralls.io/repos/github/nnadeau/pybotics/badge.svg?branch=master + :target: https://coveralls.io/github/nnadeau/pybotics?branch=master +.. |codecov| image:: https://codecov.io/gh/nnadeau/pybotics/branch/master/graph/badge.svg + :target: https://codecov.io/gh/nnadeau/pybotics +.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/9d4f77b167874a049e97731181e2b53a + :target: https://www.codacy.com/app/nicholas-nadeau/pybotics?utm_source=github.com&utm_medium=referral&utm_content=nnadeau/pybotics&utm_campaign=Badge_Grade +.. |Code Climate| image:: https://codeclimate.com/github/nnadeau/pybotics/badges/gpa.svg + :target: https://codeclimate.com/github/nnadeau/pybotics +.. |Issue Count| image:: https://codeclimate.com/github/nnadeau/pybotics/badges/issue_count.svg + :target: https://codeclimate.com/github/nnadeau/pybotics