Merge branch 'master' into vuejs
This commit is contained in:
commit
269000ab85
|
|
@ -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']
|
||||
|
|
@ -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/*
|
||||
|
|
@ -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
|
||||
|
|
|
|||
35
README.md
35
README.md
|
|
@ -2,22 +2,23 @@ Platypush
|
|||
=========
|
||||
|
||||
[](https://travis-ci.org/BlackLight/platypush)
|
||||
[](https://platypush.readthedocs.io/en/latest/?badge=latest)
|
||||
[](https://docs.platypush.tech/en/latest/)
|
||||
[](https://pypi.python.org/pypi/platypush/)
|
||||
[](https://git.platypush.tech/platypush/platypush/-/blob/master/LICENSE.txt)
|
||||
[](https://git.platypush.tech/platypush/platypush/-/commits/master/)
|
||||
[](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).
|
||||
- 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.
|
||||
- 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).
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -42,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:
|
||||
|
||||
|
|
@ -54,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:
|
||||
|
||||
|
|
@ -76,6 +77,20 @@ 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
|
||||
- [Medium articles](https://medium.com/tag/platypush/archive) that describe hands-on applications of platypush
|
||||
- [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
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,11 +7,11 @@ 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
|
||||
.. _Medium stories: https://medium.com/tag/platypush/archive
|
||||
.. _Blog articles: https://blog.platypush.tech
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
|
|
|||
|
|
@ -1,6 +0,0 @@
|
|||
``platypush.message.event.path``
|
||||
================================
|
||||
|
||||
.. automodule:: platypush.message.event.path
|
||||
:members:
|
||||
|
||||
|
|
@ -1 +0,0 @@
|
|||
Subproject commit 070d113f423ed1ce90cc354f1d9ea2e562bc6033
|
||||
|
|
@ -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:
|
||||
|
|
|
|||
Loading…
Reference in New Issue