Skip to main content

Simple Python wrapper for Uptime Kuma

Project description

pythonkuma

Simple Python wrapper for Uptime Kuma

build codecov PyPI version PyPI - Downloads "Buy Me A Coffee" GitHub Sponsor


📖 Documentation


📦 Installation

pip install pythonkuma

Example

import asyncio

import aiohttp

from pythonkuma import UptimeKuma

URL = "https://uptime.exampe.com"
API_KEY = "api_key"


async def main():

    async with aiohttp.ClientSession() as session:
        uptime_kuma = UptimeKuma(session, URL, API_KEY)
        response = await uptime_kuma.metrics()
        print(response)


asyncio.run(main())

🛠 Contributing

Contributions are welcome! To contribute:

  1. Fork the repository.
  2. Create a new branch.
  3. Make your changes and commit them.
  4. Submit a pull request.

Make sure to follow the contributing guidelines.


📜 License

This project is licensed under the MIT License - see the LICENSE file for details.


❤️ Support

If you find this project useful, consider buying me a coffee ☕ or sponsoring me on GitHub!


Credit

This library is a fork of pyuptimekuma by @jayakornk

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pythonkuma-0.4.0.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pythonkuma-0.4.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file pythonkuma-0.4.0.tar.gz.

File metadata

  • Download URL: pythonkuma-0.4.0.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: Hatch/1.16.3 cpython/3.12.3 HTTPX/0.28.1

File hashes

Hashes for pythonkuma-0.4.0.tar.gz
Algorithm Hash digest
SHA256 9058ed5cdd80089d1d678b636263ae4d9d5f92d38b8f6b3c08e71c74ed6924ef
MD5 a51f3f291976b85b43ecd05aeb1a11c0
BLAKE2b-256 5a3267bef2162fe97db8ee3341ea8ab736901cd8ad8128797bfe53f4ee434b67

See more details on using hashes here.

File details

Details for the file pythonkuma-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: pythonkuma-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: Hatch/1.16.3 cpython/3.12.3 HTTPX/0.28.1

File hashes

Hashes for pythonkuma-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0730a98e22b176644a868786ee291a3c391d1d45729dbd3e9f231fd1624056c2
MD5 4272f25b244bca8c2e836506b4b4fe87
BLAKE2b-256 24ad211cb70d2a8496828d136af67b3af0ef996980adabee591d74705d561ac1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page