From b2f16faa11b19c6731f230dd76f39313876d2652 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Felix=20B=C3=B6hm?= Date: Tue, 6 Aug 2024 22:18:21 +0200 Subject: [PATCH] docs: Update links to repo and documentation --- README.md | 10 +++++----- docs/conf.py | 2 +- docs/connecting-to-the-broker.md | 2 +- docs/index.md | 8 ++++---- pyproject.toml | 33 +++++++++++++++++++------------- 5 files changed, 31 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index d873bf0..e4db073 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # The idiomatic asyncio MQTT client 🙌 -test PyPI downloads PyPI version Supported Python versions Coverage Typing: strict Ruff License: BSD-3-Clause +test PyPI downloads PyPI version Supported Python versions Coverage Typing: strict Ruff License: BSD-3-Clause -**Documentation:** [https://sbtinstruments.github.io/aiomqtt](https://sbtinstruments.github.io/aiomqtt) +**Documentation:** [https://aiomqtt.felixboehm.dev](https://aiomqtt.felixboehm.dev) --- @@ -46,7 +46,7 @@ The only dependency is [paho-mqtt](https://github.com/eclipse/paho.mqtt.python). If you can't wait for the latest version, install directly from GitHub with: ``` -pip install git+https://github.com/sbtinstruments/aiomqtt +pip install git+https://github.com/empicano/aiomqtt ``` ### Note for Windows users @@ -73,7 +73,7 @@ Note that the underlying paho-mqtt library is dual-licensed. One of the licenses ## Contributing -We're happy about contributions to aiomqtt! 🎉 You can get started by reading [CONTRIBUTING.md](https://github.com/sbtinstruments/aiomqtt/blob/main/CONTRIBUTING.md). +We're happy about contributions to aiomqtt! 🎉 You can get started by reading [CONTRIBUTING.md](https://github.com/empicano/aiomqtt/blob/main/CONTRIBUTING.md). ## Versioning @@ -81,4 +81,4 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm ## Changelog -See [CHANGELOG.md](https://github.com/sbtinstruments/aiomqtt/blob/main/CHANGELOG.md), which follows the principles of [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). +See [CHANGELOG.md](https://github.com/empicano/aiomqtt/blob/main/CHANGELOG.md), which follows the principles of [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). diff --git a/docs/conf.py b/docs/conf.py index 4212015..98a46e7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -32,7 +32,7 @@ "footer_icons": [ { "name": "GitHub", - "url": "https://github.com/sbtinstruments/aiomqtt", + "url": "https://github.com/empicano/aiomqtt", "html": """ diff --git a/docs/connecting-to-the-broker.md b/docs/connecting-to-the-broker.md index 9e2578b..2a3f71c 100644 --- a/docs/connecting-to-the-broker.md +++ b/docs/connecting-to-the-broker.md @@ -24,7 +24,7 @@ If your use case does not allow you to use a context manager, you can use the cl ``` ```{note} -Examples use the public [mosquitto test broker](https://test.mosquitto.org/). You can connect to this broker without any credentials. Alternatively, our [contribution guide](https://github.com/sbtinstruments/aiomqtt/blob/main/CONTRIBUTING.md) contains an explanation of how to spin up a local mosquitto broker with Docker. +Examples use the public [mosquitto test broker](https://test.mosquitto.org/). You can connect to this broker without any credentials. Alternatively, our [contribution guide](https://github.com/empicano/aiomqtt/blob/main/CONTRIBUTING.md) contains an explanation of how to spin up a local mosquitto broker with Docker. All examples in this documentation are self-contained and runnable as-is. ``` diff --git a/docs/index.md b/docs/index.md index 33177ce..bf78478 100644 --- a/docs/index.md +++ b/docs/index.md @@ -33,9 +33,9 @@ migration-guide-v2 :caption: Project links :hidden: -GitHub -Issue tracker -Changelog -Contributing +GitHub +Issue tracker +Changelog +Contributing PyPI ``` diff --git a/pyproject.toml b/pyproject.toml index 1e7a67c..c348ec1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,14 +1,25 @@ [tool.poetry] name = "aiomqtt" -version = "0.0.0" # Placeholder: Managed by poetry-dynamic-versioning +version = "0.0.0" # Placeholder: Managed by poetry-dynamic-versioning description = "The idiomatic asyncio MQTT client, wrapped around paho-mqtt" license = "BSD-3-Clause" -authors = ["Frederik Aalund ", "Felix Böhm ", "Jonathan Plasse "] +authors = [ + "Frederik Aalund ", + "Felix Böhm ", + "Jonathan Plasse ", +] readme = "README.md" -packages = [{include = "aiomqtt"}] -repository = "https://github.com/sbtinstruments/aiomqtt" -documentation = "https://sbtinstruments.github.io/aiomqtt" -keywords = ["mqtt", "iot", "internet-of-things", "asyncio", "paho-mqtt", "mqttv5"] +packages = [{ include = "aiomqtt" }] +repository = "https://github.com/empicano/aiomqtt" +documentation = "https://aiomqtt.felixboehm.dev" +keywords = [ + "mqtt", + "iot", + "internet-of-things", + "asyncio", + "paho-mqtt", + "mqttv5", +] classifiers = [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", @@ -16,12 +27,12 @@ classifiers = [ ] [tool.poetry.urls] -"Issue tracker" = "https://github.com/sbtinstruments/aiomqtt/issues" +"Issue tracker" = "https://github.com/empicano/aiomqtt/issues" [tool.poetry.dependencies] python = "^3.8" paho-mqtt = "^2.1.0" -typing-extensions = {version = "^4.4.0", markers = "python_version < '3.10'"} +typing-extensions = { version = "^4.4.0", markers = "python_version < '3.10'" } [tool.poetry.group.dev] optional = true @@ -138,12 +149,8 @@ pretty = true filterwarnings = [ "error", "ignore:ssl.PROTOCOL_TLS is deprecated:DeprecationWarning", - # TODO(jonathan): Remove these once we finish the migration to the new API - "ignore:Callback API version 1 is deprecated, update to latest version:DeprecationWarning", -] -markers = [ - "network: tests that requires network access" ] +markers = ["network: tests that requires network access"] xfail_strict = true [tool.coverage.run] # https://coverage.readthedocs.io/en/latest/config.html#run