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.3.1.tar.gz (6.3 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.3.1-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pythonkuma-0.3.1.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for pythonkuma-0.3.1.tar.gz
Algorithm Hash digest
SHA256 e62609c8783968433cd1e74d0f65f83a2b1fcb392721528f323f3f14324c4f29
MD5 20f9c6ea9877bfc099b0878b8ec71a1d
BLAKE2b-256 494719fd663664939cd25aef82b38354e0a42427750dcfba4b6a72f9778c1f27

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pythonkuma-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for pythonkuma-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 02d6e674b6fcd4f585b0c07cec09699ce69cf6be23f7d38f676822f1edb1be80
MD5 faa0648ee0b0039ec0ee6cc428f8ab4f
BLAKE2b-256 e1b6739d16b29f9a28e87350cfa76f14a85424aadb0544b01bdffbfa51b4c6f3

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