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 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.5.0.tar.gz (7.0 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.5.0-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pythonkuma-0.5.0.tar.gz
  • Upload date:
  • Size: 7.0 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.5.0.tar.gz
Algorithm Hash digest
SHA256 7739b0ae1feed6c4d905d993cee9c32065e68e640883b5596cc3cab7f1737e6c
MD5 a5b7e10058294f90085c13eb6afa8296
BLAKE2b-256 4c314ab1cb14d060ed734db3cf37b0d529dcedb38dd21bf38a08eded7b36fe4e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pythonkuma-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 7.2 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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cdfeb5c26184f23add3648574b75fcee01669c85334191cceffe12460f25e381
MD5 1dffcb5eabffdebbfbb3faea27514514
BLAKE2b-256 2a903eaf35caabf0d34075709bfcda8ca6b61779a0369361b6a2d225be949114

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