README.rst 4.5 KB
Newer Older
Fabrice Salvaire's avatar
Fabrice Salvaire committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
.. -*- Mode: rst -*-

.. -*- Mode: rst -*-

..
   |PythonicGcodeMachineUrl|
   |PythonicGcodeMachineHomePage|_
   |PythonicGcodeMachineDoc|_
   |PythonicGcodeMachine@github|_
   |PythonicGcodeMachine@readthedocs|_
   |PythonicGcodeMachine@readthedocs-badge|
   |PythonicGcodeMachine@pypi|_

.. |ohloh| image:: https://www.openhub.net/accounts/230426/widgets/account_tiny.gif
   :target: https://www.openhub.net/accounts/fabricesalvaire
   :alt: Fabrice Salvaire's Ohloh profile
   :height: 15px
   :width:  80px

Fabrice Salvaire's avatar
Fabrice Salvaire committed
20
.. |PythonicGcodeMachineUrl| replace:: https://github.com/FabriceSalvaire/pythonic-gcode-machine
Fabrice Salvaire's avatar
Fabrice Salvaire committed
21 22

.. |PythonicGcodeMachineHomePage| replace:: PythonicGcodeMachine Home Page
Fabrice Salvaire's avatar
Fabrice Salvaire committed
23
.. _PythonicGcodeMachineHomePage: https://github.com/FabriceSalvaire/pythonic-gcode-machine
Fabrice Salvaire's avatar
Fabrice Salvaire committed
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81

.. |PythonicGcodeMachine@readthedocs-badge| image:: https://readthedocs.org/projects/PythonicGcodeMachine/badge/?version=latest
   :target: http://PythonicGcodeMachine.readthedocs.org/en/latest

.. |PythonicGcodeMachine@github| replace:: https://github.com/FabriceSalvaire/PythonicGcodeMachine
.. .. _PythonicGcodeMachine@github: https://github.com/FabriceSalvaire/PythonicGcodeMachine

.. |PythonicGcodeMachine@pypi| replace:: https://pypi.python.org/pypi/PythonicGcodeMachine
.. .. _PythonicGcodeMachine@pypi: https://pypi.python.org/pypi/PythonicGcodeMachine

.. |Build Status| image:: https://travis-ci.org/FabriceSalvaire/PythonicGcodeMachine.svg?branch=master
   :target: https://travis-ci.org/FabriceSalvaire/PythonicGcodeMachine
   :alt: PythonicGcodeMachine build status @travis-ci.org

.. |Pypi Version| image:: https://img.shields.io/pypi/v/PythonicGcodeMachine.svg
   :target: https://pypi.python.org/pypi/PythonicGcodeMachine
   :alt: PythonicGcodeMachine last version

.. |Pypi License| image:: https://img.shields.io/pypi/l/PythonicGcodeMachine.svg
   :target: https://pypi.python.org/pypi/PythonicGcodeMachine
   :alt: PythonicGcodeMachine license

.. |Pypi Python Version| image:: https://img.shields.io/pypi/pyversions/PythonicGcodeMachine.svg
   :target: https://pypi.python.org/pypi/PythonicGcodeMachine
   :alt: PythonicGcodeMachine python version

..  coverage test
..  https://img.shields.io/pypi/status/Django.svg
..  https://img.shields.io/github/stars/badges/shields.svg?style=social&label=Star
.. -*- Mode: rst -*-

.. |Python| replace:: Python
.. _Python: http://python.org

.. |PyPI| replace:: PyPI
.. _PyPI: https://pypi.python.org/pypi

.. |Numpy| replace:: Numpy
.. _Numpy: http://www.numpy.org

.. |IPython| replace:: IPython
.. _IPython: http://ipython.org

.. |Sphinx| replace:: Sphinx
.. _Sphinx: http://sphinx-doc.org

.. |NIST-RS-274| replace:: The NIST RS274NGC Interpreter — Version 3
.. _NIST-RS-274: https://www.nist.gov/publications/nist-rs274ngc-interpreter-version-3

.. |LinuxCNC| replace:: Linux CNC
.. _LinuxCNC: http://linuxcnc.org/docs/2.7/html/gcode/overview.html

.. |Machinekit| replace:: Machinekit
.. _Machinekit: http://www.machinekit.io

.. |YAML| replace:: YAML
.. _YAML: https://yaml.org

Fabrice Salvaire's avatar
Fabrice Salvaire committed
82 83 84
=============================
 The Pythonic G-code Machine
=============================
Fabrice Salvaire's avatar
Fabrice Salvaire committed
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103

|Pypi License|
|Pypi Python Version|

|Pypi Version|

* Quick Link to `Production Branch <https://github.com/FabriceSalvaire/PythonicGcodeMachine/tree/master>`_
* Quick Link to `Devel Branch <https://github.com/FabriceSalvaire/PythonicGcodeMachine/tree/devel>`_

Overview
========

What is PythonicGcodeMachine ?
------------------------------

.. free and open source

PythonicGcodeMachine is a Python toolkit to work with RS-274 / ISO G-Code.

Fabrice Salvaire's avatar
Fabrice Salvaire committed
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
.. -*- mode: rst -*-

PythonicGcodeMachine features:

* a compliant RS-274 / ISO G-code parser which is automatically generated from grammar and easy to
  derivate to support other flavours,
* an abstract syntax tree (AST) API,
* some G-code flavour aspects are handled by YAML files for maximum flexibility,
* tools to manipulate and validate G-code,
* and more ..

PythonicGcodeMachine supports these G-code flavours:

* RS-274 **(full support)**
* Fanuc *(partially)*
* Heidenhain *(partially)*
* LinuxCNC *(partially)*
Fabrice Salvaire's avatar
Fabrice Salvaire committed
121

Fabrice Salvaire's avatar
Fabrice Salvaire committed
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
Where is the Documentation ?
----------------------------

The documentation is available on the |PythonicGcodeMachineHomePage|_.

What are the main features ?
----------------------------

* to be completed

How to install it ?
-------------------

Look at the `installation <@project_url@/installation.html>`_ section in the documentation.

Credits
=======

Authors: `Fabrice Salvaire <http://fabrice-salvaire.fr>`_

News
====

.. -*- Mode: rst -*-


.. no title here

V0 2018-12-22
-------------

Started project