Skip to content

Commit a5a00ae

Browse files
committed
bump version to 1.0.0
1 parent 84d4009 commit a5a00ae

File tree

4 files changed

+39
-5
lines changed

4 files changed

+39
-5
lines changed

CHANGELOG.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,39 @@
11
## Changelog
22

3+
### Release 1.0.0
4+
5+
#### Features
6+
- add `ssl_verify` parameter
7+
- add `wait_events` parameter
8+
- implement context manager for UptimeKumaApi class
9+
- drop Python 3.6 support
10+
- implement `get_monitor_status` helper method
11+
- implement timeouts for all methods (`timeout` parameter)
12+
- add support for uptime kuma 1.21.3
13+
- drop support for Uptime Kuma versions < 1.21.3
14+
- check for required notification arguments
15+
- raise exception when deleting an element that does not exist
16+
- replace raw return values with enum values
17+
18+
#### Bugfixes
19+
- adjust monitor `status` type to allow all used values
20+
- fix memory leak
21+
22+
#### BREAKING CHANGES
23+
- Python 3.7+ required
24+
- maintenance parameter `timezone` renamed to `timezoneOption`
25+
- Removed the `wait_timeout` parameter. Use the new `timeout` parameter instead. The `timeout` parameter specifies how many seconds the client should wait for the connection, an expected event or a server response.
26+
- changed return values of methods `get_heartbeats`, `get_important_heartbeats`, `avg_ping`, `uptime`, `get_heartbeat`, `cert_info`
27+
- Uptime Kuma versions < 1.21.3 are not supported in uptime-kuma-api 1.0.0+
28+
- Removed the `get_heartbeat` method. This method was never intended to retrieve information. Use `get_heartbeats` or `get_important_heartbeats` instead.
29+
- Types of return values changed to enum values:
30+
- monitor: `type` (str -> MonitorType), `status` (bool -> MonitorStatus), `authMethod` (str -> AuthMethod)
31+
- notification: `type` (str -> NotificationType)
32+
- docker host: `dockerType` (str -> DockerType)
33+
- status page: `style` (str -> IncidentStyle)
34+
- maintenance: `strategy` (str -> MaintenanceStrategy)
35+
- proxy: `protocol` (str -> ProxyProtocol)
36+
337
### Release 0.13.0
438

539
#### Feature

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ Python version 3.7+ is required.
1010

1111
Supported Uptime Kuma versions:
1212

13-
| uptime-kuma-api | Uptime Kuma |
13+
| Uptime Kuma | uptime-kuma-api |
1414
|-----------------|-----------------|
15-
| 1.0.0 | 1.21.3 |
16-
| 0.1.0 - 0.13.0 | 1.17.0 - 1.21.2 |
15+
| 1.21.3 | 1.0.0 |
16+
| 1.17.0 - 1.21.2 | 0.1.0 - 0.13.0 |
1717

1818
Installation
1919
---

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
"packaging"
3636
],
3737
classifiers=[
38-
"Development Status :: 1 - Planning",
38+
"Development Status :: 5 - Production/Stable",
3939
"Environment :: Web Environment",
4040
"Intended Audience :: Developers",
4141
"License :: OSI Approved :: MIT License",

uptime_kuma_api/__version__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
__title__ = "uptime_kuma_api"
2-
__version__ = "0.13.0"
2+
__version__ = "1.0.0"
33
__author__ = "Lucas Held"
44
__license__ = "MIT"
55
__copyright__ = "Copyright 2023 Lucas Held"

0 commit comments

Comments
 (0)