Metadata-Version: 2.1
Name: plotink
Version: 1.0.1
Summary: UNKNOWN
Home-page: https://github.com/evil-mad/plotink
Author: Evil Mad Scientist Laboratories
Author-email: contact@evilmadscientist.com
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=2.7
Description-Content-Type: text/markdown
Requires-Dist: ink-extensions
Requires-Dist: pyserial (>=2.7.0)
Provides-Extra: dev
Requires-Dist: coverage ; extra == 'dev'
Provides-Extra: test

# plotink
Helper routines for Inkscape extensions to drive EggBot, WaterColorBot, AxiDraw, and similar plotter-type machines.

This project is hosted at: https://github.com/evil-mad/plotink

## Overview

These library files are intended to provide a single place to edit routines that are common to the [EggBot extensions for Inkscape](https://github.com/evil-mad/EggBot/), the [WaterColorBot extensions for Inkscape](https://github.com/evil-mad/wcb-ink/), the [AxiDraw extensions for Inkscape](https://github.com/evil-mad/axidraw/), and derivative machines. Hosting these in a single place means less duplication of code, and (more importantly) reduces the number of cases where identical code changes need to be made in multiple places.

The three library files are:

* ebb_serial.py - Routines for communicating with the EiBotBoard by USB serial (PySerial 2.7 + required).
* ebb_motion.py - Common commands for interacting with the robot
* plot_utils.py - Additional helper functions for managing the plot.


## Python version support

This version, 1.0.1, is the last to support python 2.7. Future versions will require Python 3.5 or newer.

## Logging

This library uses the standard python logging module. Suggested configurations follow.

For manual command of AxiDraw, print info, warnings, and errors to stdout:

```
import logging

logging.basicConfig(level=logging.INFO, format='%(message)s')
```

For running as an inkscape extension, print errors to inkscape's extension errors log:
```
import logging

logging.basicConfig(level=logging.ERR,
        format='%(message)s'),
        filename = "~/.config/inkscape/extension-errors.log")
```


