Releases: ShaneSutro/Vestaboard
v1.2.4
v1.2.0
Local API + Read / Write Support
This version adds support for Vestaboard's Local API and the read/write feature of the board.
When using the local API, be sure to checkout Vestaboard's documentation so that you get the correct enablement token from the Vestaboard team. As always, if you spot any issues, please fill out an issue here.
- Shane
v1.2.0a2
This release adds support for the Read / Write Vestaboard API.
Note that you will need a special read/write enabled API key, which you can get within your developer settings.
I'm working on better error messaging right now, but if you try to use the endpoint and receive a KeyError
that "currentMessage" does not exist, that usually means you used the wrong or an invalid API key for the read write endpoint.
Documentation forthcoming, but Vestaboard's documentation can be found here.
v1.2.0a1
v1.1.0
What's Changed
- Fix warning display for raw when charList is not 6. by @jsdiaz in #24
- Add error when instantiating
Board()
with a string by @ShaneSutro in #28 - Add bracketed character support in
.convert()
method by @ShaneSutro in #29
New Contributors
Full Changelog: v1.0.0...v1.1.0
v1.0.0
Version 1.0.0 Enhancements
-
Improved regex means reduced errors when processing your converted line - simplified and enhanced regex with additional cases
- Contribution by @Xaelias
-
Bugfix for
Formatter.convertLine()
method - no longer throws "Index out of range" error when the last character in a line is a character code ({63}
, for example)- Contribution by @natekspencer
-
.raw()
method now adds padding lines when a list with a length of less than 6 is provided- Contribution by @MiTo0o
Bumping to version 1.0.0 - stable
What's Changed
- Bump urllib3 from 1.26.3 to 1.26.4 by @dependabot in https://github.com/SonicRift/Vestaboard/pull/13
- Alesieur/2021 05 31/update formatters tests and regex by @Xaelias in https://github.com/SonicRift/Vestaboard/pull/14
- Bump urllib3 from 1.26.4 to 1.26.5 by @dependabot in https://github.com/SonicRift/Vestaboard/pull/15
- Fix index out of range error in convertLine by @natekspencer in https://github.com/SonicRift/Vestaboard/pull/18
- ♻️ Update README with disclaimer and donation info by @SonicRift in https://github.com/SonicRift/Vestaboard/pull/19
- Closes Issue20 by @MiTo0o in https://github.com/SonicRift/Vestaboard/pull/21
- Update docs for padding method by @SonicRift in https://github.com/SonicRift/Vestaboard/pull/22
New Contributors
- @dependabot made their first contribution in https://github.com/SonicRift/Vestaboard/pull/13
- @Xaelias made their first contribution in https://github.com/SonicRift/Vestaboard/pull/14
- @natekspencer made their first contribution in https://github.com/SonicRift/Vestaboard/pull/18
- @MiTo0o made their first contribution in https://github.com/SonicRift/Vestaboard/pull/21
Full Changelog: ShaneSutro/PrevVestaboard@v0.5.0...v1.0.0
Version 0.5.0 Enhancements
Change Log:
- Removed redundant print statements and unused variables
- Added the ability to pass in an installable that was instantiated with API Key and API Secret only along with Subscription ID when instantiating a new
Board()
.- To use this feature, ensure you pass
getSubscription=False
when instantiating a newInstallable
, then pass both the Installable + SubscriptionID to theBoard()
- Read the docs for more information
- To use this feature, ensure you pass
Version 0.4.0 - Stable
Change Log:
- Added
color
parameter toFormatter.convertLine()
method - Added
spaceBuffer
parameter toFormatter.convertLine()
method- Setting
spaceBuffer=True
will add a single blank space before and after the passed in string, increasing the size of the string by 2 - Space buffer works in conjunction with the
justify='center|left|right'
parameter and only adds a buffer between fill colors
- Setting
Breaking Changes:
Formatter.convertLine()
center
,left
,right
params deprecated- Now use
justify='center | left | right'
to justify a single line
Bug Fixes:
- When passing in valid character codes within brackets in the pattern 'code - text - code' (ex: '{63}{63} Test {63}{63}`), you would get an error message that an invalid character had been used. This has been rectified.
Version 0.3.1 - Stable
Changelog:
- Added unit tests for better coverage
- Added verification
- Vestaboard's API will return
statuscode=500
if you send invalid characters, but will not generate an error; code will now throw anException
if an invalid character is passed in - Updated Formatter to be a class with additional methods
- Vestaboard's API will return
Version 0.2.0
Changes:
-
Added
.raw()
method to theBoard
class- Allows passing in a 6 x 22 array for rendering
-
Adjusted the Formatter to be a class object and added two public methods:
.convert()
.convertLine()
-
Updated documentation
-
Added type checking to the
.raw()
method