From 13f4edbc92a04e65cdc97280ff51232311e7dd59 Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Thu, 28 Jan 2021 14:48:09 +0100 Subject: [PATCH 01/13] Updated README --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 67735fc53..be9885a1a 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,28 @@ Platypush [![Last Commit](https://img.shields.io/github/last-commit/BlackLight/platypush.svg)](https://git.platypush.tech/platypush/platypush/-/commits/master/) [![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://git.platypush.tech/platypush/platypush/-/issues) -- Advised read: [**Getting started with Platypush**](https://medium.com/@automationguru/automate-your-house-your-life-and-everything-else-around-with-platypush-dba1cd13e3f6) (Medium article). +## Funding + +If you use and love Platypush, please consider [buying me a coffee/beer](https://paypal.me/fabiomanganiello). + +I've been working on Platypush all by myself in my spare time for the past few years, and I've made sure that it remains open and free, and I've even opted to pay +for a self-hosted solution for the repo, the blog and the website to make sure that it always stays free, independent and without paywalls. + +If you think that I've done a good job, please consider donating some of your spare change - I'm definitely not planning to get rich with this project, but I'd love +to have at least the monthly costs for the server covered by users. + +Issues and requests opened by donors will also be given priority over others. + +--- + +- Advised read: [**Getting started with Platypush**](https://blog.platypush.tech/article/Ultimate-self-hosted-automation-with-Platypush). + +- The [blog](https://blog.platypush.tech) is in general a good place to get more insights on what you can build with it and inspiration about possible usages. - The [wiki](https://git.platypush.tech/platypush/platypush/-/wikis/home) also contains many resources on getting started. - Extensive documentation for all the available integrations and messages is available on [ReadTheDocs](https://platypush.readthedocs.io/en/latest/). -- Also check other [Medium stories](https://medium.com/tag/platypush/archive) to get more insights on what you can build with it and inspiration about possible usages. - - If you have issues/feature requests/enhancement ideas please [create an issue](https://git.platypush.tech/platypush/platypush/-/issues). A [Reddit channel](https://www.reddit.com/r/platypush) is also available for more general questions. From 32ec76611a0a476cde29ddc38eb6061c82dcd838 Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Thu, 28 Jan 2021 14:48:19 +0100 Subject: [PATCH 02/13] Removed .github folder --- .github/FUNDING.yml | 12 ----------- .github/workflows/python-publish.yml | 31 ---------------------------- 2 files changed, 43 deletions(-) delete mode 100644 .github/FUNDING.yml delete mode 100644 .github/workflows/python-publish.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index 78614e20b..000000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1,12 +0,0 @@ -# These are supported funding model platforms - -github: [BlackLight] -patreon: # Replace with a single Patreon username -open_collective: # Replace with a single Open Collective username -ko_fi: # Replace with a single Ko-fi username -tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel -community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry -liberapay: # Replace with a single Liberapay username -issuehunt: # Replace with a single IssueHunt username -otechie: # Replace with a single Otechie username -custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml deleted file mode 100644 index 4e1ef42d2..000000000 --- a/.github/workflows/python-publish.yml +++ /dev/null @@ -1,31 +0,0 @@ -# This workflows will upload a Python Package using Twine when a release is created -# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries - -name: Upload Python Package - -on: - release: - types: [created] - -jobs: - deploy: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - name: Set up Python - uses: actions/setup-python@v2 - with: - python-version: '3.x' - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install setuptools wheel twine - - name: Build and publish - env: - TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} - TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }} - run: | - python setup.py sdist bdist_wheel - twine upload dist/* From fda8872a15a3c116bcd5ec03750e8c5a621bddfb Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Sun, 31 Jan 2021 01:28:58 +0100 Subject: [PATCH 03/13] Updated README --- README.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index be9885a1a..96460f758 100644 --- a/README.md +++ b/README.md @@ -8,20 +8,6 @@ Platypush [![Last Commit](https://img.shields.io/github/last-commit/BlackLight/platypush.svg)](https://git.platypush.tech/platypush/platypush/-/commits/master/) [![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://git.platypush.tech/platypush/platypush/-/issues) -## Funding - -If you use and love Platypush, please consider [buying me a coffee/beer](https://paypal.me/fabiomanganiello). - -I've been working on Platypush all by myself in my spare time for the past few years, and I've made sure that it remains open and free, and I've even opted to pay -for a self-hosted solution for the repo, the blog and the website to make sure that it always stays free, independent and without paywalls. - -If you think that I've done a good job, please consider donating some of your spare change - I'm definitely not planning to get rich with this project, but I'd love -to have at least the monthly costs for the server covered by users. - -Issues and requests opened by donors will also be given priority over others. - ---- - - Advised read: [**Getting started with Platypush**](https://blog.platypush.tech/article/Ultimate-self-hosted-automation-with-Platypush). - The [blog](https://blog.platypush.tech) is in general a good place to get more insights on what you can build with it and inspiration about possible usages. @@ -91,5 +77,17 @@ To get started: - [Wiki](https://git.platypush.tech/platypush/platypush/-/wikis/home) for installation notes, quick start, examples and architecture reference - [Read the docs](https://platypush.readthedocs.io/en/latest/) for a complete reference on the available plugins and backends -- [Medium articles](https://medium.com/tag/platypush/archive) that describe hands-on applications of platypush +- [Blog articles](https://blog.platypush.tech) describing hands-on applications of Platypush + +## Funding + +If you use and love Platypush, please consider [buying me a coffee/beer](https://paypal.me/fabiomanganiello). + +I've been working on Platypush all by myself in my spare time for the past few years. I've made sure that it remains open and free, and I've even opted to pay +for a self-hosted solution for the repo, the blog and the website to make sure that it always stays free, independent and without paywalls. + +If you like to use it, please consider donating some spare change - I'm definitely not planning to get rich with this project, but it'd be nice if users +could help covering the costs for the server. + +Issues and requests opened by donors will also be given priority over others. From fca0c2265c42ca295bea7786955079a031cc6492 Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Sun, 31 Jan 2021 12:42:02 +0100 Subject: [PATCH 04/13] Added extra alias "snowboy" for "hotword" --- setup.py | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.py b/setup.py index c32a8fefb..22ef24c55 100755 --- a/setup.py +++ b/setup.py @@ -210,6 +210,7 @@ setup( 'lastfm': ['pylast'], # Support for custom hotword detection 'hotword': ['snowboy'], + 'snowboy': ['snowboy'], # Support for real-time MIDI events 'midi': ['rtmidi'], # Support for RaspberryPi GPIO From 1c84891df637c712d35ef4ad7bdef3c31779285a Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Sat, 23 Jan 2021 14:47:18 +0100 Subject: [PATCH 05/13] Update README.md --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 96460f758..ed326af3f 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,8 @@ Platypush - Extensive documentation for all the available integrations and messages is available on [ReadTheDocs](https://platypush.readthedocs.io/en/latest/). - If you have issues/feature requests/enhancement ideas please [create an issue](https://git.platypush.tech/platypush/platypush/-/issues). -A [Reddit channel](https://www.reddit.com/r/platypush) is also available for more general questions. + +- A [Reddit channel](https://www.reddit.com/r/platypush) is also available for more general questions. --- @@ -79,15 +80,17 @@ To get started: - [Read the docs](https://platypush.readthedocs.io/en/latest/) for a complete reference on the available plugins and backends - [Blog articles](https://blog.platypush.tech) describing hands-on applications of Platypush +--- + ## Funding If you use and love Platypush, please consider [buying me a coffee/beer](https://paypal.me/fabiomanganiello). -I've been working on Platypush all by myself in my spare time for the past few years. I've made sure that it remains open and free, and I've even opted to pay +I've been working on Platypush all by myself in my spare time for the past few years, and I've made sure that it remains open and free, and I've even opted to pay for a self-hosted solution for the repo, the blog and the website to make sure that it always stays free, independent and without paywalls. -If you like to use it, please consider donating some spare change - I'm definitely not planning to get rich with this project, but it'd be nice if users -could help covering the costs for the server. +If you think that I've done a good job, please consider donating some of your spare change - I'm definitely not planning to get rich with this project, but I'd love +to have at least the monthly costs for the server covered by users. Issues and requests opened by donors will also be given priority over others. From dca81de5a3761a636f745097d23fc2fa3928f5bc Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Thu, 28 Jan 2021 14:48:09 +0100 Subject: [PATCH 06/13] Updated README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index ed326af3f..ceba89f33 100644 --- a/README.md +++ b/README.md @@ -94,3 +94,19 @@ to have at least the monthly costs for the server covered by users. Issues and requests opened by donors will also be given priority over others. +--- + +## Funding + +If you use and love Platypush, please consider [buying me a coffee/beer](https://paypal.me/fabiomanganiello). + +I've been working on Platypush all by myself in my spare time for the past few years, and I've made sure that it remains open and free, and I've even opted to pay +for a self-hosted solution for the repo, the blog and the website to make sure that it always stays free, independent and without paywalls. + +If you think that I've done a good job, please consider donating some of your spare change - I'm definitely not planning to get rich with this project, but I'd love +to have at least the monthly costs for the server covered by users. + +Issues and requests opened by donors will also be given priority over others. + +--- + From 3332c5c573daa9a39cfc435073278665e878c5f5 Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Sun, 31 Jan 2021 01:28:58 +0100 Subject: [PATCH 07/13] Updated README --- README.md | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/README.md b/README.md index ceba89f33..ff5df8d85 100644 --- a/README.md +++ b/README.md @@ -93,20 +93,3 @@ If you think that I've done a good job, please consider donating some of your sp to have at least the monthly costs for the server covered by users. Issues and requests opened by donors will also be given priority over others. - ---- - -## Funding - -If you use and love Platypush, please consider [buying me a coffee/beer](https://paypal.me/fabiomanganiello). - -I've been working on Platypush all by myself in my spare time for the past few years, and I've made sure that it remains open and free, and I've even opted to pay -for a self-hosted solution for the repo, the blog and the website to make sure that it always stays free, independent and without paywalls. - -If you think that I've done a good job, please consider donating some of your spare change - I'm definitely not planning to get rich with this project, but I'd love -to have at least the monthly costs for the server covered by users. - -Issues and requests opened by donors will also be given priority over others. - ---- - From cca4444af293313683a00d85274fd8f088993a1a Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Sun, 31 Jan 2021 01:28:58 +0100 Subject: [PATCH 08/13] Updated README --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index ff5df8d85..ed326af3f 100644 --- a/README.md +++ b/README.md @@ -93,3 +93,4 @@ If you think that I've done a good job, please consider donating some of your sp to have at least the monthly costs for the server covered by users. Issues and requests opened by donors will also be given priority over others. + From 0411145ebf8f29e976a8f0014bb2d09b042e2b45 Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Tue, 2 Feb 2021 00:32:39 +0100 Subject: [PATCH 09/13] Updated blog link --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index f1600bb0f..1851a92f7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,7 +11,7 @@ For more information on Platypush please check out: .. _GitHub page: https://git.platypush.tech/platypush/platypush .. _online wiki: https://git.platypush.tech/platypush/platypush/-/wikis/home -.. _Medium stories: https://medium.com/tag/platypush/archive +.. _Blog articles: https://blog.platypush.tech .. toctree:: :maxdepth: 3 From 41b8b738d6cb0b077d72559d96e18013e75b8d07 Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Tue, 2 Feb 2021 00:50:17 +0100 Subject: [PATCH 10/13] Fixed links referenced in the documentation --- docs/source/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 1851a92f7..702b0c545 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,9 +7,9 @@ For more information on Platypush please check out: * The `Gitlab page`_ of the project * The `online wiki`_ for quickstart and examples -* The `Medium stories`_ for inspiration about possible projects +* The `Blog articles`_ for inspiration on use-cases possible projects -.. _GitHub page: https://git.platypush.tech/platypush/platypush +.. _Gitlab page: https://git.platypush.tech/platypush/platypush .. _online wiki: https://git.platypush.tech/platypush/platypush/-/wikis/home .. _Blog articles: https://blog.platypush.tech From 254045283bde8f7bd6b79e7b5055adf45228749e Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Tue, 2 Feb 2021 00:54:17 +0100 Subject: [PATCH 11/13] Removed deprecated message.events.path module --- docs/source/platypush/events/path.rst | 6 ------ 1 file changed, 6 deletions(-) delete mode 100644 docs/source/platypush/events/path.rst diff --git a/docs/source/platypush/events/path.rst b/docs/source/platypush/events/path.rst deleted file mode 100644 index e02160d1a..000000000 --- a/docs/source/platypush/events/path.rst +++ /dev/null @@ -1,6 +0,0 @@ -``platypush.message.event.path`` -================================ - -.. automodule:: platypush.message.event.path - :members: - From e08d4c21b832e50759364c5f9d21cd8c214b941b Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Tue, 2 Feb 2021 01:05:07 +0100 Subject: [PATCH 12/13] Documentation domain name moved to docs.platypush.tech --- README.md | 10 +++++----- examples/conf/config.yaml | 12 ++++++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ed326af3f..6b6e37733 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Platypush ========= [![Build Status](https://travis-ci.org/BlackLight/platypush.svg?branch=master)](https://travis-ci.org/BlackLight/platypush) -[![Documentation Status](https://readthedocs.org/projects/platypush/badge/?version=latest)](https://platypush.readthedocs.io/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/platypush/badge/?version=latest)](https://docs.platypush.tech/en/latest/) [![pip version](https://img.shields.io/pypi/v/platypush.svg?style=flat)](https://pypi.python.org/pypi/platypush/) [![License](https://img.shields.io/github/license/BlackLight/platypush.svg)](https://git.platypush.tech/platypush/platypush/-/blob/master/LICENSE.txt) [![Last Commit](https://img.shields.io/github/last-commit/BlackLight/platypush.svg)](https://git.platypush.tech/platypush/platypush/-/commits/master/) @@ -14,7 +14,7 @@ Platypush - The [wiki](https://git.platypush.tech/platypush/platypush/-/wikis/home) also contains many resources on getting started. -- Extensive documentation for all the available integrations and messages is available on [ReadTheDocs](https://platypush.readthedocs.io/en/latest/). +- Extensive documentation for all the available integrations and messages is available on [ReadTheDocs](https://docs.platypush.tech/en/latest/). - If you have issues/feature requests/enhancement ideas please [create an issue](https://git.platypush.tech/platypush/platypush/-/issues). @@ -43,7 +43,7 @@ You can use Platypush to do things like: - Play local videos, YouTube videos and torrent links - Get weather forecast for your location - Build your own web dashboard with calendar, weather, news and music controls (basically, anything that has a Platypush web widget) -- ...and much more (basically, anything that comes with a [Platypush plugin](https://platypush.readthedocs.io/en/latest/plugins.html)) +- ...and much more (basically, anything that comes with a [Platypush plugin](https://docs.platypush.tech/en/latest/plugins.html)) Imagine the ability of executing all the actions above through messages delivered through: @@ -55,7 +55,7 @@ Imagine the ability of executing all the actions above through messages delivere - [Kafka](https://kafka.apache.org) - [Redis](https://redis.io) - [MQTT](https://mqtt.org) -- ...amd much more (basically, anything that comes with a [Platypush backend](https://platypush.readthedocs.io/en/latest/backends.html)) +- ...amd much more (basically, anything that comes with a [Platypush backend](https://docs.platypush.tech/en/latest/backends.html)) Imagine the ability of building custom event hooks to automatically trigger any actions: @@ -77,7 +77,7 @@ Imagine the ability of running the application, with lots of those bundled featu To get started: - [Wiki](https://git.platypush.tech/platypush/platypush/-/wikis/home) for installation notes, quick start, examples and architecture reference -- [Read the docs](https://platypush.readthedocs.io/en/latest/) for a complete reference on the available plugins and backends +- [Read the docs](https://docs.platypush.tech/en/latest/) for a complete reference on the available plugins and backends - [Blog articles](https://blog.platypush.tech) describing hands-on applications of Platypush --- diff --git a/examples/conf/config.yaml b/examples/conf/config.yaml index fdcb16791..bb70e5625 100644 --- a/examples/conf/config.yaml +++ b/examples/conf/config.yaml @@ -40,10 +40,10 @@ device_id: myname # a plugin class. The methods of the class with @action annotation will # be exported as runnable actions, while the __init__ parameters are # configuration attributes that you can initialize in your config.yaml. -# Plugin classes are documented at https://platypush.readthedocs.io/en/latest/plugins.html +# Plugin classes are documented at https://docs.platypush.tech/en/latest/plugins.html # # In this example we'll configure the light.hue plugin, see -# https://platypush.readthedocs.io/en/latest/platypush/plugins/light.hue.html +# https://docs.platypush.tech/en/latest/platypush/plugins/light.hue.html # for reference. You can easily install the required dependencies for the plugin through # pip install 'platypush[hue]' light.hue: @@ -54,14 +54,14 @@ light.hue: - Living Room # Example configuration of music.mpd plugin, see -# https://platypush.readthedocs.io/en/latest/platypush/plugins/music.mpd.html +# https://docs.platypush.tech/en/latest/platypush/plugins/music.mpd.html # You can easily install the dependencies through pip install 'platypush[mpd]' music.mpd: host: localhost port: 6600 # Example configuration of media.chromecast plugin, see -# https://platypush.readthedocs.io/en/latest/platypush/plugins/media.chromecast.html +# https://docs.platypush.tech/en/latest/platypush/plugins/media.chromecast.html # You can easily install the dependencies through pip install 'platypush[chromecast]' media.chromecast: chromecast: Living Room TV @@ -97,10 +97,10 @@ calendar: # to happen and either trigger events or provide additional services on top of platypush. # Just like plugins, backends are classes whose configuration matches one-to-one the # supported parameters on the __init__ methods. You can check the documentation for the -# available backends here: https://platypush.readthedocs.io/en/latest/backends.html. +# available backends here: https://docs.platypush.tech/en/latest/backends.html. # Moreover, most of the backends will generate events that you can react to through custom # event hooks. Check here for the events documentation: -# https://platypush.readthedocs.io/en/latest/events.html +# https://docs.platypush.tech/en/latest/events.html # # You may usually want to enable the HTTP backend, as it provides many useful features on # top of platypush. Among those: From 0ad4597daf9ef8538754e371cc5d65bd4656ea5f Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Tue, 2 Feb 2021 01:26:54 +0100 Subject: [PATCH 13/13] No need to keep the wiki as a submodule --- .gitmodules | 3 --- docs/wiki | 1 - 2 files changed, 4 deletions(-) delete mode 160000 docs/wiki diff --git a/.gitmodules b/.gitmodules index 6e175b470..a10ba2bc2 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,6 +1,3 @@ [submodule "platypush/plugins/gpio/sensor/ir/mlx90640/lib"] path = platypush/plugins/camera/ir/mlx90640/lib url = https://github.com/pimoroni/mlx90640-library -[submodule "docs/wiki"] - path = docs/wiki - url = https://git.platypush.tech/platypush/platypush.wiki.git diff --git a/docs/wiki b/docs/wiki deleted file mode 160000 index 070d113f4..000000000 --- a/docs/wiki +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 070d113f423ed1ce90cc354f1d9ea2e562bc6033