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.0rc0.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.0rc0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pythonkuma-0.4.0rc0.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.0rc0.tar.gz
Algorithm Hash digest
SHA256 ebda78b46f64b434fcfba0a9a665ba4d2a838fbab4c26d588250bdb18ac7fdbd
MD5 9c90b981d5114186a45ad5011eacc8b7
BLAKE2b-256 8900a32dd50492353b1d359053385b1b37a090598d43fd6e6be9c89b5b755a60

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pythonkuma-0.4.0rc0-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.0rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 3c14dbd3773d4d3ecf27b9087045218162236012c356ebb7c4936a678f1490c6
MD5 3faaacc39805800b3ebe46e6711e6bdc
BLAKE2b-256 b0dacf6181cf9aefea985af86c57de8af65de553016d281c6fd87437535b06da

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