https://github.com/simplyprint/printer-ws-client

https://github.com/simplyprint/printer-ws-client

Last synced: 12 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/simplyprint/printer-ws-client
• Owner: SimplyPrint
• License: agpl-3.0
• Created: 2022-10-04T14:14:42.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-06-20T23:42:58.000Z (12 months ago)
• Last Synced: 2025-06-30T04:17:08.107Z (12 months ago)
• Language: Python
• Homepage: https://simplyprint.github.io/printer-ws-client/
• Size: 894 KB
• Stars: 7
• Watchers: 0
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# SimplyPrint Websocket Client

> A python package to simplify the use of the SimplyPrint websocket API to easily integrate with

> the  platform.

This package version v1.0.0 is under major development and is not yet ready for use. API is not stable and will change.

## Usage

See [docs/index.md](docs/index.md) to get started.

## TODO

- [ ] Add usage documentation

- [ ] Add examples

- [ ] Add tests for event system and reactivity

- [ ] Unify event bus api with printer events.

- [ ] Move away from `ClientCli` and integrate with `click` directly

- [ ] Expand client to a plugin/module based system

- [ ] Update config backend (Only pydantic) + custom settings provider + more settings

- [ ] Provide nicer interface for sending especially job_info (e.i. job management logic) so we can bundle important

  steps together for consistency.

- [ ] Improve `tick` hook with something like the OctoPrint-SimplyPrint FlexTimer solution to avoid having to manually

  keep track of time