Skip to main content

Python package used to write to, read from, and interpret g-code files

Project description

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 to install gcodeBuddy.

pip install gcodeBuddy

Usage

# imports marlin.Command class
from gcodeBuddy.marlin import Command

# initializing marlin.Command instance with
# string representing line of g-code
sample_line = Command("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")

sample_line.set_param("X", 32.1)
# returns 32.1
sample_line.get_param("X")


# imports marlin_commands function
from gcodeBuddy import marlin_commands

# returns list of supported commands, scraped directly from Marlin's website
supported_commands = marlin_commands()

View the Documentation

https://gcodebuddy.readthedocs.io/

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gcodeBuddy-0.2.6.tar.gz (11.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page