Skip to content

Commit

Permalink
docs: Update links to repo and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
empicano committed Aug 6, 2024
1 parent fd976ee commit b2f16fa
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 24 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# The idiomatic asyncio MQTT client 🙌

<a href="https://github.com/sbtinstruments/aiomqtt/actions/workflows/test.yml"><img alt="test" src="https://github.com/sbtinstruments/aiomqtt/actions/workflows/test.yml/badge.svg"></a> <a href="https://pypi.org/project/aiomqtt"><img alt="PyPI downloads" src="https://img.shields.io/pypi/dm/aiomqtt"></a> <a href="https://pypi.org/project/aiomqtt"><img alt="PyPI version" src="https://img.shields.io/pypi/v/aiomqtt"></a> <a href="https://pypi.org/project/aiomqtt"><img alt="Supported Python versions" src="https://img.shields.io/pypi/pyversions/aiomqtt.svg"></a> <a href="https://codecov.io/gh/sbtinstruments/aiomqtt"><img alt="Coverage" src="https://img.shields.io/codecov/c/github/sbtinstruments/aiomqtt"></a> <a href="https://github.com/sbtinstruments/aiomqtt"><img alt="Typing: strict" src="https://img.shields.io/badge/typing-strict-green.svg"></a> <a href="https://github.com/astral-sh/ruff"><img alt="Ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"></a> <a href="https://github.com/sbtinstruments/aiomqtt/blob/main/LICENSE"><img alt="License: BSD-3-Clause" src="https://img.shields.io/github/license/sbtinstruments/aiomqtt"></a>
<a href="https://github.com/empicano/aiomqtt/actions/workflows/test.yml"><img alt="test" src="https://github.com/empicano/aiomqtt/actions/workflows/test.yml/badge.svg"></a> <a href="https://pypi.org/project/aiomqtt"><img alt="PyPI downloads" src="https://img.shields.io/pypi/dm/aiomqtt"></a> <a href="https://pypi.org/project/aiomqtt"><img alt="PyPI version" src="https://img.shields.io/pypi/v/aiomqtt"></a> <a href="https://pypi.org/project/aiomqtt"><img alt="Supported Python versions" src="https://img.shields.io/pypi/pyversions/aiomqtt.svg"></a> <a href="https://codecov.io/gh/sbtinstruments/aiomqtt"><img alt="Coverage" src="https://img.shields.io/codecov/c/github/sbtinstruments/aiomqtt"></a> <a href="https://github.com/empicano/aiomqtt"><img alt="Typing: strict" src="https://img.shields.io/badge/typing-strict-green.svg"></a> <a href="https://github.com/astral-sh/ruff"><img alt="Ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"></a> <a href="https://github.com/empicano/aiomqtt/blob/main/LICENSE"><img alt="License: BSD-3-Clause" src="https://img.shields.io/github/license/empicano/aiomqtt"></a>

**Documentation:** [https://sbtinstruments.github.io/aiomqtt](https://sbtinstruments.github.io/aiomqtt)
**Documentation:** [https://aiomqtt.felixboehm.dev](https://aiomqtt.felixboehm.dev)

---

Expand Down Expand Up @@ -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
Expand All @@ -73,12 +73,12 @@ 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

This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Breaking changes will only occur in major `X.0.0` releases.

## 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/).
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"footer_icons": [
{
"name": "GitHub",
"url": "https://github.com/sbtinstruments/aiomqtt",
"url": "https://github.com/empicano/aiomqtt",
"html": """
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
Expand Down
2 changes: 1 addition & 1 deletion docs/connecting-to-the-broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```
Expand Down
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ migration-guide-v2
:caption: Project links
:hidden:
GitHub <https://github.com/sbtinstruments/aiomqtt>
Issue tracker <https://github.com/sbtinstruments/aiomqtt/issues>
Changelog <https://github.com/sbtinstruments/aiomqtt/blob/main/CHANGELOG.md>
Contributing <https://github.com/sbtinstruments/aiomqtt/blob/main/CONTRIBUTING.md>
GitHub <https://github.com/empicano/aiomqtt>
Issue tracker <https://github.com/empicano/aiomqtt/issues>
Changelog <https://github.com/empicano/aiomqtt/blob/main/CHANGELOG.md>
Contributing <https://github.com/empicano/aiomqtt/blob/main/CONTRIBUTING.md>
PyPI <https://pypi.org/project/aiomqtt/>
```
33 changes: 20 additions & 13 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,27 +1,38 @@
[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 <[email protected]>", "Felix Böhm <[email protected]>", "Jonathan Plasse <[email protected]>"]
authors = [
"Frederik Aalund <[email protected]>",
"Felix Böhm <[email protected]>",
"Jonathan Plasse <[email protected]>",
]
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",
"Operating System :: OS Independent",
]

[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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit b2f16fa

Please sign in to comment.