Metadata-Version: 2.1
Name: gcodeBuddy
Version: 0.0.3
Summary: Python package used to write to, read from, and interpret g-code files
Home-page: https://gcodeBuddy.readthedocs.io/
Author: Spencer Bertram
Author-email: spenbert02@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: matplotlib

# gcodeBuddy



gcodeBuddy is a python library intended to ease the process

of writing, reading, and interpreting g-code files, particularly geared towards

3D printer g-code.



## Installation



Use the package manager

[pip](https://pip.pypa.io/en/stable/) to install gcodeBuddy.



```bash

pip install gcodeBuddy

```



## Usage



```python

# imports Line class

from gcodeBuddy import Line



# initializing Line instance with string representing g-code line

sample_line = Line("G0 X12.3 Y45.6")



# returns "G0"

sample_line.get_command()



# returns True

sample_line.has_param("X")



# returns 12.3

sample_line.get_param("X")

```



## Supported G-code Flavors



Marlin



## Contributions



Pull requests are more than welcome. For most cases, open

an issue first to discuss what you would like to change.



## License



[MIT](https://choosealicense.com/licenses/mit/)



