Releases: mikeckennedy/umami-python
v0.2.20
Umami-Python Release Notes
Since 5fa3518 (7 commits)
🚀 New Features
- Development and Testing Tracking: Added options to disable tracking for development
and testing environments. This allows users to control data collection based on their needs.
When tracking is disabled:
- ✅ No HTTP requests are made to your Umami server
- ✅ API calls still validate parameters (helps catch configuration issues)
- ✅ All other functions work normally (login, websites, stats, etc.)
- ✅ Functions return appropriate values for compatibility
📚 Documentation
- Documented the heartbeat check feature for monitoring system health.
- Added documentation for new methods in the Umami API:
get_heartbeat
and
enabled/disable
.
🧹 Maintenance
- Sorted some imports in various files to improve code organization and readability.
- Fixed a minor typo in the documentation, ensuring consistency across the project.
v0.2.19
Umami-Python Release Notes
Since 1d17c01 (16 commits)
🚀 New Features
- Heartbeat Functions: Added asynchronous (
heartbeat_async
) and synchronous (heartbeat
)
versions of the existing heartbeat function for improved import flexibility. - Added website stats and active users functions (
website_stats
,active_users
) Thanks @orangethewell
🐛 Bug Fixes
- Login Fix: Corrected the API data handling from
data
tojson
in the login process. Originally, this was not a problem with the server, but it has started failing. If you have encountered login errors, this may fix it.
⚡ Performance
- Heartbeat Function Optimization: Improved the performance of the heartbeat function by
optimizing its execution flow.
v0.2.18
Umami-Python Release Notes
Since 3a08f77 (2 commits)
🚀 New Features
- Python Version Update: Upgraded to Python 3.13 and 3.14, providing better support for modern
applications.
🐛 Bug Fixes
- API Call Method Fix: Corrected the use of
data
instead ofjson
in login API calls,
ensuring proper data transmission.
Originally, this was not a problem with the server, but it has started failing. If you have encountered login errors, this may fix it.
v0.2.17
Adds is_logged_in() -> bool
method to check whether login has been called and was successful.
v0.2.15
- Fixes schema change from Umami 2.9 to 2.10 on websites response
- Includes new heartbeat function from 0.1.14 release
v0.1.14
Add heartbeat API endpoint.
v0.1.13
Support IP address in new_event and new_page_view payloads, see issue #2.
It looks like Umami added the IP data field in the payload (see umami-software/umami#2479 ). It's not clear when the feature will be released in a new build ( https://github.com/umami-software/umami/releases ). But in preparation, I added the id_address parameter to both new_event and new_page_view as well as their async twins.
This is out in version 0.1.13 and on PyPI at https://pypi.org/project/umami-analytics/0.1.13/ Thanks for the idea @ddxv
v0.1.12
Add ability to pass alternative user agent to events (but be careful, umami blocks what it perceives as bots).
v0.1.11
v0.1.10
- Added platform type (e.g. Windows) to user agent.
- Added doc strings to most methods.
- Bump the version for next release.
- Added better validation for some functions.
- Added custom error types for validation.