From f219a21ff16125658a654d478ab40a204c6ebdfc Mon Sep 17 00:00:00 2001 From: tr4nt0r <4445816+tr4nt0r@users.noreply.github.com> Date: Fri, 11 Jul 2025 02:22:36 +0200 Subject: [PATCH] Update readme --- CONTRIBUTING.md | 137 ++++++++++++++++++++++++++++++++++++++++++++++++ LICENSE | 2 +- README.md | 47 ++++++++++++++++- 3 files changed, 183 insertions(+), 3 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a7bce74 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,137 @@ +# Contributing + +Contributions are welcome, and they are greatly appreciated! Every +little bit helps, and credit will always be given. + +You can contribute in many ways: + +## Types of Contributions + +### Report Bugs + +Report bugs at . + +If you are reporting a bug, please include: + +- Your operating system name and version. +- Any details about your local setup that might be helpful in + troubleshooting. +- Detailed steps to reproduce the bug. + +### Fix Bugs + +Look through the GitHub issues for bugs. Anything tagged with "bug" +and "help wanted" is open to whoever wants to implement it. + +### Implement Features + +Look through the GitHub issues for features. Anything tagged with +"enhancement" and "help wanted" is open to whoever wants to +implement it. + +### Write Documentation + +Pythonkuma could always use more documentation, whether as part of the +official Pythonkuma docs, in docstrings, or even on the web in blog +posts, articles, and such. + +### Submit Feedback + +The best way to send feedback is to file an issue at +. + +If you are proposing a feature: + +- Explain in detail how it would work. +- Keep the scope as narrow as possible, to make it easier to + implement. +- Remember that this is a volunteer-driven project, and that + contributions are welcome :) + +## Development + +Ready to contribute? Here's how to set up `pythonkuma` for +local development. + +### Setup Git + +[Fork](https://github.com/tr4nt0r/pythonkuma/fork) the `pythonkuma` repo on GitHub. + + + +Clone your fork locally: + +```bash +$ git clone git@github.com:yourusername/pythonkuma.git +``` + +Create a branch for local development: + +``` bash +$ git checkout -b name-of-your-bugfix-or-feature +``` + +Now you can make your changes locally. + + +### Setup environment + +We use [Hatch](https://hatch.pypa.io/latest/install/) to manage the development environment and production build. Ensure it's installed on your system. + +### Run unit tests + +You can run all the tests with: + +```bash +hatch run test +``` + +### Format the code + +Execute the following command to apply linting and check typing: + +```bash +hatch run lint +``` + +### Publish a new version + +You can bump the version, create a commit and associated tag with one command: + +```bash +hatch version patch +``` + +```bash +hatch version minor +``` + +```bash +hatch version major +``` + +Your default Git text editor will open so you can add information about the release. + +When you push the tag on GitHub, the workflow will automatically publish it on PyPi and a GitHub release will be created as draft. + + +## Pull Request Guidelines + +Before you submit a pull request, check that it meets these guidelines: + +1. The pull request should include tests. +2. If the pull request adds functionality, the docs should be updated. + Put your new functionality into a function with a docstring, and add + the feature to the list in README.md. +3. The pull request should work for Python 3.12 and 3.13. Check + + and make sure that the tests pass for all supported Python versions. + + +## Serve the documentation + +You can serve the Mkdocs documentation with: + +```bash +hatch run docs-serve +``` diff --git a/LICENSE b/LICENSE index 927f7ef..5a6be4f 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 Bacon +Copyright (c) 2025 Manfred Dennerlein Rodelo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index b122d81..6957e0b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,24 @@ # pythonkuma + Simple Python wrapper for Uptime Kuma -## Installation +[![build](https://github.com/tr4nt0r/pythonkuma/workflows/Build/badge.svg)](https://github.com/tr4nt0r/pythonkuma/actions) +[![codecov](https://codecov.io/gh/tr4nt0r/pythonkuma/graph/badge.svg?token=RM3MC4LP07)](https://codecov.io/gh/pythonkuma/pynecil) +[![PyPI version](https://badge.fury.io/py/pythonkuma.svg)](https://badge.fury.io/py/pythonkuma) +![PyPI - Downloads](https://img.shields.io/pypi/dm/pythonkuma?style=flat&label=pypi%20downloads) +[!["Buy Me A Coffee"](https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee)](https://www.buymeacoffee.com/tr4nt0r) +[![GitHub Sponsor](https://img.shields.io/badge/GitHub-Sponsor-blue?logo=github)](https://github.com/sponsors/tr4nt0r) + +--- + +## 📖 Documentation + +- **Full Documentation**: [https://tr4nt0r.github.io/pythonkuma](https://tr4nt0r.github.io/pythonkuma) +- **Source Code**: [ttps://github.com/tr4nt0r/pythonkuma](ttps://github.com/tr4nt0r/pythonkuma) + +--- + +## 📦 Installation ```shell pip install pythonkuma @@ -29,9 +46,35 @@ async def main(): 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](CONTRIBUTING.md). + +--- + +## 📜 License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +--- + +## ❤️ Support + +If you find this project useful, consider [buying me a coffee ☕](https://www.buymeacoffee.com/tr4nt0r) or [sponsoring me on GitHub](https://github.com/sponsors/tr4nt0r)! + +--- + ## Credit This library is a fork of **pyuptimekuma** by [@jayakornk](https://github.com/jayakornk)