Releases: djotaku/ELDonationTracker
v5.2.4 Bugfix for Emojis in Donor Name Crash
This fixes a crash that would occur on Windows if a donor had emojis in their name. Update at your convenience.
Installation/Usage Instructions
tl;dr:
Windows Users
Grab one of the 2 files below. You can choose :
- the single-binary (eldonationtracker.for.Windows.v5.2.4.exe): One file that you use to launch the program.
- the zip file (Extra Life Donation Tracker for Windows v5.2.4.zip - which has been the main release method for at least a year now): A folder in which you'll find the executable.
The trade-off is that the single-binary is simpler, but takes a little longer to launch.
Linux users
use PyPi or git clone.
For more detailed instructions
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports. Pull requests welcome on the devel branch.
#v5.2.4
Release Notes
User-Facing Changes
- Fix issue #137 where Emojis in the donor name cause a crash
Developer-Facing or API Changes
None. If you are coming from a pre-5.0 version, please see: https://github.com/djotaku/ELDonationTracker/releases/tag/v5.2.0
v5.2.3 Fix for Windows Executable
I'm very sorry to have missed an error in the creation of the creation of the Windows executables. That is to say, there was no bug in the code, but when Github's CI made the executable, it made one that didn't work. So if you're using this on the commandline or on Linux, you can skip this release. Once again, I apologize for not doing a better job testing the executables. Thank you to Jurare89 and Gomerstraw on the Extra Life Discord for finding this error with enough time to fix before game day!
Since nothing else has changed, here are the release notes from 5.2.2:
Once again, thanks to EnochSoul for discovering an issue. This one should be relatively rare, but if all of your donors are anonymous, there could be a crash because the Extra Life API doesn't return anything on the donor endpoint. So this would fix that for you. If you have at least one donor who is not anonymous and v5.2 works for you, there's no need to update at this time.
Installation/Usage Instructions
tl;dr:
Windows Users
Grab one of the 2 files below. You can choose :
- the single-binary (eldonationtracker.for.Windows.v5.2.2.exe): One file that you use to launch the program.
- the zip file (Extra Life Donation Tracker for Windows v5.2.2.zip - which has been the main release method for at least a year now): A folder in which you'll find the executable.
The trade-off is that the single-binary is simpler, but takes a little longer to launch.
Linux users
use PyPi or git clone.
For more detailed instructions
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports. Pull requests welcome on the devel branch.
Release Notes
User-Facing Changes
None. If you are coming from a pre-5.0 version, please see: https://github.com/djotaku/ELDonationTracker/releases/tag/v5.2.0
Developer-Facing or API Changes
None. If you are coming from a pre-5.0 version, please see: https://github.com/djotaku/ELDonationTracker/releases/tag/v5.2.0
v5.2.3 Fix for Windows Executable (bad tag)
I'm very sorry to have missed an error in the creation of the creation of the Windows executables. That is to say, there was no bug in the code, but when Github's CI made the executable, it made one that didn't work. So if you're using this on the commandline or on Linux, you can skip this release. Once again, I apologize for not doing a better job testing the executables. Thank you to Jurare89 and Gomerstraw on the Extra Life Discord for finding this error with enough time to fix before game day!
Since nothing else has changed, here are the release notes from 5.2.2:
Once again, thanks to EnochSoul for discovering an issue. This one should be relatively rare, but if all of your donors are anonymous, there could be a crash because the Extra Life API doesn't return anything on the donor endpoint. So this would fix that for you. If you have at least one donor who is not anonymous and v5.2 works for you, there's no need to update at this time.
Installation/Usage Instructions
tl;dr:
Windows Users
Grab one of the 2 files below. You can choose :
- the single-binary (eldonationtracker.for.Windows.v5.2.2.exe): One file that you use to launch the program.
- the zip file (Extra Life Donation Tracker for Windows v5.2.2.zip - which has been the main release method for at least a year now): A folder in which you'll find the executable.
The trade-off is that the single-binary is simpler, but takes a little longer to launch.
Linux users
use PyPi or git clone.
For more detailed instructions
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports. Pull requests welcome on the devel branch.
Release Notes
User-Facing Changes
None. If you are coming from a pre-5.0 version, please see: https://github.com/djotaku/ELDonationTracker/releases/tag/v5.2.0
Developer-Facing or API Changes
None. If you are coming from a pre-5.0 version, please see: https://github.com/djotaku/ELDonationTracker/releases/tag/v5.2.0
v5.2.2 Fully Anonymous Donor Fix
Once again, thanks to EnochSoul for discovering an issue. This one should be relatively rare, but if all of your donors are anonymous, there could be a crash because the Extra Life API doesn't return anything on the donor endpoint. So this would fix that for you. If you have at least one donor who is not anonymous and v5.2 works for you, there's no need to update at this time.
Installation/Usage Instructions
tl;dr:
Windows Users
Grab one of the 2 files below. You can choose :
- the single-binary (eldonationtracker.for.Windows.v5.2.2.exe): One file that you use to launch the program.
- the zip file (Extra Life Donation Tracker for Windows v5.2.2.zip - which has been the main release method for at least a year now): A folder in which you'll find the executable.
The trade-off is that the single-binary is simpler, but takes a little longer to launch.
Linux users
use PyPi or git clone.
For more detailed instructions
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports. Pull requests welcome on the devel branch.
Release Notes
User-Facing Changes
None. If you are coming from a pre-5.0 version, please see: https://github.com/djotaku/ELDonationTracker/releases/tag/v5.2.0
Developer-Facing or API Changes
None. If you are coming from a pre-5.0 version, please see: https://github.com/djotaku/ELDonationTracker/releases/tag/v5.2.0
v5.2.1 Documentation Fix
Special thanks to EnochSoul for discovering a bug in the documentation relating to users not using the GUI and not participating as part of a team. This release fixes that documentation.
The rest remains the same as the 5.0 release, so I will reproduce those notes below:
Installation/Usage Instructions
tl;dr:
Windows Users
Grab one of the 2 files below. You can choose :
- the single-binary (eldonationtracker.for.Windows.v5.2.1.exe): One file that you use to launch the program.
- the zip file (Extra Life Donation Tracker for Windows v5.2.1.zip - which has been the main release method for at least a year now): A folder in which you'll find the executable.
The trade-off is that the single-binary is simpler, but takes a little longer to launch.
Linux users
use PyPi or git clone.
For more detailed instructions
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports. Pull requests welcome on the devel branch.
Release Notes
User-Facing Changes
- extralifedonation.py changed to participant.py -> important if launching on the command line or terminal instead of via the GUI
- use of the "rich" Python module to add color to the command line output. On Windows you may wish to change your command line background color to a lighter color. After that, re-launch eldonationtracker and it should have the new color settings. (Worked for me in Windows 10)
- Team Donations are now available as an output. Previously I focused on team donors which I use to show where I fall in the top donors to the team. But I wanted to cover the use case where the team captain (or any team member) might want to highlight individual team donations rather than just donations to him/her self, especially during a live stream on game day. (For example, if I am focusing more on the team than on my personal donations, I might want to have the latest team donations show up so that I can thank/acknowledge the donations) Look for text files that start with Team and contain the word donation instead of donor. Add them to OBS or XSplit as you would with the rest of the data.
Developer-Facing or API Changes
- extralife_IO changed to extralife_io: in order to meet PEP8 requirements.
- extralifedonation.py changed to participant.py: Both for PEP8, but also for consistency/readability - if it holds the participant.py class, it should have that name.
- lots of API changes on participant.py
- gui.py no longer uses threading. Side effect: When the user quits the program it closes much faster now
- team.py API changes for better, more Pythonic code. Also changed to not hit the team participant API every time. This should improve performance with the limits put in place from last year's DDOS.
- cover coverage goes from 71% to...95%
- mypy runs and passes on all files
- eliminated use of IPC.txt to let the GUI know if there was a new donation. If you write your own GUI based off of my library, it is the responsibility of your GUI to set newdonation variable False after you handle the new donation. ipc.py is deprecated and should be removed in the next release.
v5.2.0 Bug Fix for new Users
Special thanks to Costuming Steven over on the Extra Life Discord for giving the program a try and reporting the bug. The changes I made in 5.0 to move away from threading caused a regression for brand new users of the program and would cause a crash upon first "run".
Additionally I decided there was too much user ambiguity in having both a save and a persist settings button in settings. This was not intuitive for the user, so I changed it to just have a "Save" button that will do a persistent save. That's really what most users want/should want so that they don't lose their settings when updating the program.
The rest remains the same as the 5.0 release, so I will reproduce those notes below:
Installation/Usage Instructions
tl;dr:
Windows Users
Grab one of the 2 files below. You can choose :
- the single-binary (eldonationtracker.for.Windows.v5.2.exe): One file that you use to launch the program.
- the zip file (Extra Life Donation Tracker for Windows v5.2.zip - which has been the main release method for at least a year now): A folder in which you'll find the executable.
The trade-off is that the single-binary is simpler, but takes a little longer to launch.
Linux users
use PyPi or git clone.
For more detailed instructions
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports. Pull requests welcome on the devel branch.
Release Notes
User-Facing Changes
- extralifedonation.py changed to participant.py -> important if launching on the command line or terminal instead of via the GUI
- use of the "rich" Python module to add color to the command line output. On Windows you may wish to change your command line background color to a lighter color. After that, re-launch eldonationtracker and it should have the new color settings. (Worked for me in Windows 10)
- Team Donations are now available as an output. Previously I focused on team donors which I use to show where I fall in the top donors to the team. But I wanted to cover the use case where the team captain (or any team member) might want to highlight individual team donations rather than just donations to him/her self, especially during a live stream on game day. (For example, if I am focusing more on the team than on my personal donations, I might want to have the latest team donations show up so that I can thank/acknowledge the donations) Look for text files that start with Team and contain the word donation instead of donor. Add them to OBS or XSplit as you would with the rest of the data.
Developer-Facing or API Changes
- extralife_IO changed to extralife_io: in order to meet PEP8 requirements.
- extralifedonation.py changed to participant.py: Both for PEP8, but also for consistency/readability - if it holds the participant.py class, it should have that name.
- lots of API changes on participant.py
- gui.py no longer uses threading. Side effect: When the user quits the program it closes much faster now
- team.py API changes for better, more Pythonic code. Also changed to not hit the team participant API every time. This should improve performance with the limits put in place from last year's DDOS.
- cover coverage goes from 71% to...95%
- mypy runs and passes on all files
- eliminated use of IPC.txt to let the GUI know if there was a new donation. If you write your own GUI based off of my library, it is the responsibility of your GUI to set newdonation variable False after you handle the new donation. ipc.py is deprecated and should be removed in the next release.
Sphinx Documentation Updates and Fixes
Absolutely nothing has changed for the user - this was a release to update to using the latest version of Sphinx, which automatically creates the documentation for this program.
Here is a repeat of the 5.0 release documentation:
A few user-facing changes and lots of developer/API changes. See the release notes section below for more!
Installation/Usage Instructions
tl;dr:
Windows Users
Grab one of the 2 files below. You can choose :
- the single-binary (eldonationtracker.for.Windows.v5.0.exe): One file that you use to launch the program.
- the zip file (Extra Life Donation Tracker for Windows v5.0.zip - which has been the main release method for at least a year now): A folder in which you'll find the executable.
The trade-off is that the single-binary is simpler, but takes a little longer to launch.
Linux users
use PyPi or git clone.
For more detailed instructions
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports. Pull requests welcome on the devel branch.
Release Notes
User-Facing Changes
- extralifedonation.py changed to participant.py -> important if launching on the command line or terminal instead of via the GUI
- use of the "rich" Python module to add color to the command line output. On Windows you may wish to change your command line background color to a lighter color. After that, re-launch eldonationtracker and it should have the new color settings. (Worked for me in Windows 10)
- Team Donations are now available as an output. Previously I focused on team donors which I use to show where I fall in the top donors to the team. But I wanted to cover the use case where the team captain (or any team member) might want to highlight individual team donations rather than just donations to him/her self, especially during a live stream on game day. (For example, if I am focusing more on the team than on my personal donations, I might want to have the latest team donations show up so that I can thank/acknowledge the donations) Look for text files that start with Team and contain the word donation instead of donor. Add them to OBS or XSplit as you would with the rest of the data.
Developer-Facing or API Changes
- extralife_IO changed to extralife_io: in order to meet PEP8 requirements.
- extralifedonation.py changed to participant.py: Both for PEP8, but also for consistency/readability - if it holds the participant.py class, it should have that name.
- lots of API changes on participant.py
- gui.py no longer uses threading. Side effect: When the user quits the program it closes much faster now
- team.py API changes for better, more Pythonic code. Also changed to not hit the team participant API every time. This should improve performance with the limits put in place from last year's DDOS.
- cover coverage goes from 71% to...95%
- mypy runs and passes on all files
- eliminated use of IPC.txt to let the GUI know if there was a new donation. If you write your own GUI based off of my library, it is the responsibility of your GUI to set newdonation variable False after you handle the new donation. ipc.py is deprecated and should be removed in the next release.
Release v5.0.0 - Team Donations Available, Color-Coded Output, and a bunch of behind-the-scenes work
A few user-facing changes and lots of developer/API changes. See the release notes section below for more!
Installation/Usage Instructions
tl;dr:
Windows Users
Grab one of the 2 files below. You can choose :
- the single-binary (eldonationtracker.for.Windows.v5.0.exe): One file that you use to launch the program.
- the zip file (Extra Life Donation Tracker for Windows v5.0.zip - which has been the main release method for at least a year now): A folder in which you'll find the executable.
The trade-off is that the single-binary is simpler, but takes a little longer to launch.
Linux users
use PyPi or git clone.
For more detailed instructions
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports. Pull requests welcome on the devel branch.
Release Notes
User-Facing Changes
- extralifedonation.py changed to participant.py -> important if launching on the command line or terminal instead of via the GUI
- use of the "rich" Python module to add color to the command line output. On Windows you may wish to change your command line background color to a lighter color. After that, re-launch eldonationtracker and it should have the new color settings. (Worked for me in Windows 10)
- Team Donations are now available as an output. Previously I focused on team donors which I use to show where I fall in the top donors to the team. But I wanted to cover the use case where the team captain (or any team member) might want to highlight individual team donations rather than just donations to him/her self, especially during a live stream on game day. (For example, if I am focusing more on the team than on my personal donations, I might want to have the latest team donations show up so that I can thank/acknowledge the donations) Look for text files that start with Team and contain the word donation instead of donor. Add them to OBS or XSplit as you would with the rest of the data.
Developer-Facing or API Changes
- extralife_IO changed to extralife_io: in order to meet PEP8 requirements.
- extralifedonation.py changed to participant.py: Both for PEP8, but also for consistency/readability - if it holds the participant.py class, it should have that name.
- lots of API changes on participant.py
- gui.py no longer uses threading. Side effect: When the user quits the program it closes much faster now
- team.py API changes for better, more Pythonic code. Also changed to not hit the team participant API every time. This should improve performance with the limits put in place from last year's DDOS.
- cover coverage goes from 71% to...95%
- mypy runs and passes on all files
- eliminated use of IPC.txt to let the GUI know if there was a new donation. If you write your own GUI based off of my library, it is the responsibility of your GUI to set newdonation variable False after you handle the new donation. ipc.py is deprecated and should be removed in the next release.
v4.4.1 Bugfix for User ID and Team ID Validation
Discovered a bug in the button that allows users to validate their User ID and Team ID. Now it will correctly check based on changes you've made in the text box.
Installation/Usage Instructions
tl;dr:
Windows Users
Grab one of the 2 files below. You can choose :
- the single-binary (eldonationtracker.for.Windows.v4.4.1.exe): One file that you use to launch the program.
- the zip file (Extra Life Donation Tracker for Windows v4.4.1.zip - which has been the main release method for at least a year now): A folder in which you'll find the executable.
The trade-off is that the single-binary is simpler, but takes a little longer to launch.
Linux users
use PyPi or git clone.
For more detailed instructions
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports. Pull requests welcome on the devel branch or 5.0 branch.
Release Notes
User-Facing Changes
- Just the bug fix mentioned above.
Developer-Facing Changes
- Just the bug fix mentioned above.
v4.4.0 Single Binary Executable for Windows
Installation/Usage Instructions
tl;dr: Windows users grab one of the 2 files below. You can choose the single-binary (eldonationtracker.exe) and just launch that OR you can get the zip file (which has been the main release method for at least a year now) - Extra Life Donation Tracker for Windows v4.4.0.zip.
Linux users use PyPi or git clone.
Installation Instructions: https://eldonationtracker.readthedocs.io/en/latest/installation.html
Usage Instructions: https://eldonationtracker.readthedocs.io/en/latest/usage.html
Please file any bug reports. Pull requests welcome on the devel branch.
Release Notes
User-Facing Changes
- If it's been a while since you updated, I did two releases in quick succession, so please review https://github.com/djotaku/ELDonationTracker/releases/tag/v4.3.0 if you didn't already.
Developer-Facing Changes
- There's a single-executable binary now. That's about it. Which makes sense as this is part of the 4.x series, so there shouldn't be too many changes.