Pynecil¶
Python library to communicate with Pinecil V2 soldering irons via Bluetooth
Documentation: https://tr4nt0r.github.io/pynecil/
Source Code: https://github.com/tr4nt0r/pynecil
Development¶
Setup environment¶
We use Hatch to manage the development environment and production build. Ensure it's installed on your system.
Run unit tests¶
You can run all the tests with:
Format the code¶
Execute the following command to apply linting and check typing:
Publish a new version¶
You can bump the version, create a commit and associated tag with one command:
Your default Git text editor will open so you can add information about the release.
When you push the tag on GitHub, the workflow will automatically publish it on PyPi and a GitHub release will be created as draft.
Serve the documentation¶
You can serve the Mkdocs documentation with:
It'll automatically watch for changes in your code.
License¶
This project is licensed under the terms of the MIT license.