Metadata-Version: 2.1
Name: pybotics
Version: 0.6.0
Summary: Python Toolbox for Robotics
Home-page: https://github.com/nnadeau/pybotics
Author: Nicholas Nadeau
Author-email: nicholas.nadeau@gmail.com
License: MIT
Keywords: python,robot,robotics,research,automation,kinematics,geometry
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Manufacturing
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
Requires-Dist: numpy (>=1.9.0)
Requires-Dist: typing (>=3.5.0)
Requires-Dist: scipy (>=1.0.0)


# ![](https://raw.githubusercontent.com/nnadeau/pybotics/master/media/robotic-arm.png) pybotics
The Python Toolbox for Robotics

|Component|Badges|
|---|---|
|Community|[![Gitter chat](https://badges.gitter.im/pybotics.png)](https://gitter.im/pybotics)|
|GitHub|[![GitHub issues](https://img.shields.io/github/issues/nnadeau/pybotics.svg)](https://github.com/nnadeau/pybotics/issues) [![GitHub forks](https://img.shields.io/github/forks/nnadeau/pybotics.svg)](https://github.com/nnadeau/pybotics/network) [![GitHub stars](https://img.shields.io/github/stars/nnadeau/pybotics.svg)](https://github.com/nnadeau/pybotics/stargazers) [![GitHub tag](https://img.shields.io/github/tag/nnadeau/pybotics.svg?maxAge=2592000?style=flat-square)](https://github.com/nnadeau/pybotics/releases)|
|PyPI|[![PyPI Version](https://img.shields.io/pypi/v/pybotics.svg)](https://pypi.python.org/pypi/pybotics) [![PyPI License](https://img.shields.io/pypi/l/pybotics.svg)](https://pypi.python.org/pypi/pybotics) [![PyPI Wheel](https://img.shields.io/pypi/wheel/pybotics.svg)](https://pypi.python.org/pypi/pybotics) [![PyPI Format](https://img.shields.io/pypi/format/pybotics.svg)](https://pypi.python.org/pypi/pybotics) [![PyPI Pythons](https://img.shields.io/pypi/pyversions/pybotics.svg)](https://pypi.python.org/pypi/pybotics) [![PyPI Implementation](https://img.shields.io/pypi/implementation/pybotics.svg)](https://pypi.python.org/pypi/pybotics)|
|Documentation|[![Documentation Status](https://readthedocs.org/projects/pybotics/badge/?version=latest)](http://pybotics.readthedocs.io/en/latest/?badge=latest)|
|Referencing|[![DOI](https://zenodo.org/badge/66797360.svg)](https://zenodo.org/badge/latestdoi/66797360)|
|CI|[![Build status](https://ci.appveyor.com/api/projects/status/jrtdgcttn2mpx33u?svg=true)](https://ci.appveyor.com/project/nnadeau/pybotics) [![Build Status](https://travis-ci.org/nnadeau/pybotics.svg?branch=master)](https://travis-ci.org/nnadeau/pybotics) [![CircleCI](https://circleci.com/gh/nnadeau/pybotics/tree/master.svg?style=svg)](https://circleci.com/gh/nnadeau/pybotics/tree/master)|
|Dependencies|[![Updates](https://pyup.io/repos/github/nnadeau/pybotics/shield.svg)](https://pyup.io/repos/github/nnadeau/pybotics/) [![Dependency Status](https://dependencyci.com/github/nnadeau/pybotics/badge)](https://dependencyci.com/github/nnadeau/pybotics)|
|Coverage|[![Coverage Status](https://coveralls.io/repos/github/nnadeau/pybotics/badge.svg?branch=master)](https://coveralls.io/github/nnadeau/pybotics?branch=master) [![codecov](https://codecov.io/gh/nnadeau/pybotics/branch/master/graph/badge.svg)](https://codecov.io/gh/nnadeau/pybotics)|
|Code Quality|[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nnadeau/pybotics/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/nnadeau/pybotics/?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/9d4f77b167874a049e97731181e2b53a)](https://www.codacy.com/app/nicholas-nadeau/pybotics?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=nnadeau/pybotics&amp;utm_campaign=Badge_Grade) [![Maintainability](https://api.codeclimate.com/v1/badges/b690bb604feee3da0d2c/maintainability)](https://codeclimate.com/github/nnadeau/pybotics/maintainability) [![Issue Count](https://codeclimate.com/github/nnadeau/pybotics/badges/issue_count.svg)](https://codeclimate.com/github/nnadeau/pybotics) [![BCH compliance](https://bettercodehub.com/edge/badge/nnadeau/pybotics?branch=master)](https://bettercodehub.com/)|

## Usage
### Installation
#### Preferred
```
pipenv install pybotics
```
- See the [`pipenv` documentation](https://docs.pipenv.org/) for more info

#### Legacy
```
pip install pybotics
```

### Applications & Examples
- [Kinematics](https://pybotics.readthedocs.io/en/latest/examples/modules.html)
- [Calibration](https://pybotics.readthedocs.io/en/latest/examples/modules.html)
- Trajectory and path planning

## Featured In
- [PyCon Canada 2017](https://2017.pycon.ca/schedule/53/)
  - [Talk Photos](https://500px.com/nicholasnadeau/galleries/pycon-canada-2017)
  - [Slides](https://github.com/nnadeau/pycon-canada-2017)
- [Montreal-Python 2017](https://www.youtube.com/watch?v=wgKoGA69YXQ)

## Development
- All branches are deployed to [PyPI's Test Site](https://testpypi.python.org/pypi/pybotics/)
- Only tags on the `master` branch are deployed to [PyPI](https://pypi.org/project/pybotics/)
- Requirements used for development (i.e., [`dev-requirements.txt`](https://github.com/nnadeau/pybotics/blob/master/dev-requirements.txt)) are pinned to a specific version to avoid the `master` branch from suddenly failing due to a package update.

## 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.

---
<div>Logo made by <a href="http://www.freepik.com" title="Freepik">Freepik</a> from <a href="http://www.flaticon.com" title="Flaticon">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0" target="_blank">CC 3.0 BY</a></div>

# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.6.0] - 2018-04-10
### Added
- Jacobian methods
- Basic usage script: `docs/examples/basic_usage.py`
- `pybotics.__version__` built-in using `setuptools_scm`
- `least_squares` IK method
- `Robot.home_joints`
- Various setters/getters
- More angle conventions and conversions
- Various useful `__repr__`
- OSX and Linux CircleCI builds
- Windows builds with AppVeyor
- `.flake8` config
- Repo bots (e.g., `.github/config.yml`, `.github/stale.yml`)

### Changed
- Simplified requirements files
- Simplified `pybotics/__init__.py` structure
- Versions now managed by `setuptools_scm`
- Simplified overall API, see examples for more detail
- Optimization vector/mask only exist in the context of `OptimizationHandler`
- `Robot.random_joints()` can return array or has `inplace` flag
- PyUp now creates PRs as individual packages are updated instead of a daily check
- Pruning/excluding files in `MANIFEST`
- Improved RTD documentation

### Fixed
- Joint limits are checked when setting `Robot.joints`
- Various CI and test improvements
- Typo in `.github/ISSUE_TEMPLATE.md`
- TravisCI `distributions` key in wrong location

## [0.5.0] - 2017-11-18
### Fixed
- [Implicit `GitPython` dependency](https://github.com/nnadeau/pybotics/issues/214)

## [0.4.1] - 2017-11-10
### Fixed
- Error in `setup.py` when installing released package from PyPI
- Fixed `requirements.txt` location in `MANIFEST.in` 

### Added
- `sdist` and `bdist` are now tested in CI

## [0.4.0] - 2017-11-08
- A big refactor of `pybotics`
- Many breaking changes to how models are designed and used
- The goal was to clean technical debt and simplify the architecture

### Added
- `pybotics.__version__`
- `CODE_OF_CONDUCT.md`
- CI helper scripts
- `docs`

### Fixed
- New PyPI test server in `.travis.yml`

### Changed
- All modules have been significantly updated
- Split requirements
- Typing now heavily relies on `collections.abc`
- Simplified `.travis.yml` configuration
- Simplified `README.md`
- More static testing
- Simplified `setup.py`
- `100%` test coverage requirement

### Removed  
- Inverse kinematics (IK) for the moment
- `README.rst`

## [0.3.2] - 2017-06-20
### CI
- Added `clean_readme.py` for `pandoc` filtering to strip and convert `README.md` to a simpler `README.rst` for PyPI
- Branches are now deployed to [Test PyPI](https://testpypi.python.org/pypi/pybotics/) upon successful build
- `pandocfilters` added to `ci-requirements.txt`
- `update_version.py` now uses Travis CI environment variables to help differentiate between tag and branch builds in order to upload unique versions (conforming to PEP440) to Test PyPI

### Misc
- Changed relative URL of logo in `README` to absolute link
- Added `Development` section

## 0.3.1
### Misc
- Migrated to pure pandoc README conversion
- Added GitHub issue and PR templates

## 0.3.0
### Travis CI
- Switched to sudo-less containers
- Upgraded to `ubuntu:trusty`
- Simplified `pip install` stage with `ci-requirements.txt`
- Added `convert_readme.py` to convert `README.md` to `README.rst` for `PyPI`
- Added strict enforcement of:
    - `mypy` (typing)
    - `flake8` (PEP8 coding style)
    - `vulture` (dead code)
    - `bandit` (security issues)
    - `pydocstyle` (docstrings)
    - `pipdeptree` (dependencies)

### Misc
- Removed `PyPI` downloads from `README` (deprecated)
- Simplified `README`
- Added logo
- Added `pyup` service
- Added `QuantifiedCode` service
- Added `Scrutinizer CI` service
- Discontinued `Python` `3.2` and `3.3` support
- Updated docstring and typing


