revil-O/platypush
1
0
Fork 0
forked from platypush/platypush
Code Pull requests Activity

Fixed bullet points indentation in Google plugins docstrings.

Browse source
This commit is contained in:
Fabio Manganiello 2024-01-18 23:58:16 +01:00
parent e022712b7b
commit e3c04d9316
5 changed files with 90 additions and 90 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
platypush/plugins/google/__init__.py
View file

@ -26,24 +26,24 @@ class GooglePlugin(Plugin):
4. Click on "Credentials", then "Create credentials" -> "OAuth client ID". 4. Click on "Credentials", then "Create credentials" -> "OAuth client ID".
5 Select "Desktop app", enter whichever name you like, and click "Create". 5. Select "Desktop app", enter whichever name you like, and click "Create".
6. Click on the "Download JSON" icon next to your newly created client ID. 6. Click on the "Download JSON" icon next to your newly created client ID.
Save the JSON file under Save the JSON file under
``<WORKDIR>/credentials/google/client_secret.json``. ``<WORKDIR>/credentials/google/client_secret.json``.
7.1. If you're running the service on a desktop environment, then you 7. If you're running the service on a desktop environment, then you
can just start the application. A browser window will open and can just start the application. A browser window will open and
you'll be asked to authorize the application - you may be prompted you'll be asked to authorize the application - you may be prompted
with a warning because you are running a personal and potentially with a warning because you are running a personal and potentially
unverified application. After authorizing the application, the unverified application. After authorizing the application, the
process will save the credentials under process will save the credentials under
``<WORKDIR>/credentials/google/<list,of,scopes>.json`` and proceed ``<WORKDIR>/credentials/google/<list,of,scopes>.json`` and proceed
with the plugin initialization. with the plugin initialization.
7.2. If you're running the service on a headless environment, or you 8. If you're running the service on a headless environment, or you
prefer to manually generate the credentials file before copying to prefer to manually generate the credentials file before copying to
another machine, you can run the following command: another machine, you can run the following command:
.. code-block:: bash .. code-block:: bash
@ -53,12 +53,12 @@ class GooglePlugin(Plugin):
[--noauth_local_webserver] \ [--noauth_local_webserver] \
<WORKDIR>/credentials/google/client_secret.json <WORKDIR>/credentials/google/client_secret.json
When launched with ``--noauth_local_webserver``, the script will When launched with ``--noauth_local_webserver``, the script will
start a local webserver and print a URL that should be opened in start a local webserver and print a URL that should be opened in
your browser. After authorizing the application, you may be your browser. After authorizing the application, you may be
prompted with a code that you should copy and paste back to the prompted with a code that you should copy and paste back to the
script. Otherwise, if you're running the script on a desktop, a script. Otherwise, if you're running the script on a desktop, a
browser window will be opened automatically. browser window will be opened automatically.
""" """

36
platypush/plugins/google/calendar/__init__.py
View file

@ -25,24 +25,24 @@ class GoogleCalendarPlugin(GooglePlugin, CalendarInterface):
4. Click on "Credentials", then "Create credentials" -> "OAuth client ID". 4. Click on "Credentials", then "Create credentials" -> "OAuth client ID".
5 Select "Desktop app", enter whichever name you like, and click "Create". 5. Select "Desktop app", enter whichever name you like, and click "Create".
6. Click on the "Download JSON" icon next to your newly created client ID. 6. Click on the "Download JSON" icon next to your newly created client ID.
Save the JSON file under Save the JSON file under
``<WORKDIR>/credentials/google/client_secret.json``. ``<WORKDIR>/credentials/google/client_secret.json``.
7.1. If you're running the service on a desktop environment, then you 7. If you're running the service on a desktop environment, then you
can just start the application. A browser window will open and can just start the application. A browser window will open and
you'll be asked to authorize the application - you may be prompted you'll be asked to authorize the application - you may be prompted
with a warning because you are running a personal and potentially with a warning because you are running a personal and potentially
unverified application. After authorizing the application, the unverified application. After authorizing the application, the
process will save the credentials under process will save the credentials under
``<WORKDIR>/credentials/google/<list,of,scopes>.json`` and proceed ``<WORKDIR>/credentials/google/<list,of,scopes>.json`` and proceed
with the plugin initialization. with the plugin initialization.
7.2. If you're running the service on a headless environment, or you 8. If you're running the service on a headless environment, or you
prefer to manually generate the credentials file before copying to prefer to manually generate the credentials file before copying to
another machine, you can run the following command: another machine, you can run the following command:
.. code-block:: bash .. code-block:: bash
@ -52,12 +52,12 @@ class GoogleCalendarPlugin(GooglePlugin, CalendarInterface):
[--noauth_local_webserver] \ [--noauth_local_webserver] \
<WORKDIR>/credentials/google/client_secret.json <WORKDIR>/credentials/google/client_secret.json
When launched with ``--noauth_local_webserver``, the script will When launched with ``--noauth_local_webserver``, the script will
start a local webserver and print a URL that should be opened in start a local webserver and print a URL that should be opened in
your browser. After authorizing the application, you may be your browser. After authorizing the application, you may be
prompted with a code that you should copy and paste back to the prompted with a code that you should copy and paste back to the
script. Otherwise, if you're running the script on a desktop, a script. Otherwise, if you're running the script on a desktop, a
browser window will be opened automatically. browser window will be opened automatically.
""" """

36
platypush/plugins/google/drive/__init__.py
View file

@ -25,24 +25,24 @@ class GoogleDrivePlugin(GooglePlugin):
4. Click on "Credentials", then "Create credentials" -> "OAuth client ID". 4. Click on "Credentials", then "Create credentials" -> "OAuth client ID".
5 Select "Desktop app", enter whichever name you like, and click "Create". 5. Select "Desktop app", enter whichever name you like, and click "Create".
6. Click on the "Download JSON" icon next to your newly created client ID. 6. Click on the "Download JSON" icon next to your newly created client ID.
Save the JSON file under Save the JSON file under
``<WORKDIR>/credentials/google/client_secret.json``. ``<WORKDIR>/credentials/google/client_secret.json``.
7.1. If you're running the service on a desktop environment, then you 7. If you're running the service on a desktop environment, then you
can just start the application. A browser window will open and can just start the application. A browser window will open and
you'll be asked to authorize the application - you may be prompted you'll be asked to authorize the application - you may be prompted
with a warning because you are running a personal and potentially with a warning because you are running a personal and potentially
unverified application. After authorizing the application, the unverified application. After authorizing the application, the
process will save the credentials under process will save the credentials under
``<WORKDIR>/credentials/google/<list,of,scopes>.json`` and proceed ``<WORKDIR>/credentials/google/<list,of,scopes>.json`` and proceed
with the plugin initialization. with the plugin initialization.
7.2. If you're running the service on a headless environment, or you 8. If you're running the service on a headless environment, or you
prefer to manually generate the credentials file before copying to prefer to manually generate the credentials file before copying to
another machine, you can run the following command: another machine, you can run the following command:
.. code-block:: bash .. code-block:: bash
@ -52,12 +52,12 @@ class GoogleDrivePlugin(GooglePlugin):
[--noauth_local_webserver] \ [--noauth_local_webserver] \
<WORKDIR>/credentials/google/client_secret.json <WORKDIR>/credentials/google/client_secret.json
When launched with ``--noauth_local_webserver``, the script will When launched with ``--noauth_local_webserver``, the script will
start a local webserver and print a URL that should be opened in start a local webserver and print a URL that should be opened in
your browser. After authorizing the application, you may be your browser. After authorizing the application, you may be
prompted with a code that you should copy and paste back to the prompted with a code that you should copy and paste back to the
script. Otherwise, if you're running the script on a desktop, a script. Otherwise, if you're running the script on a desktop, a
browser window will be opened automatically. browser window will be opened automatically.
""" """

36
platypush/plugins/google/fit/__init__.py
View file

@ -22,24 +22,24 @@ class GoogleFitPlugin(GooglePlugin):
4. Click on "Credentials", then "Create credentials" -> "OAuth client ID". 4. Click on "Credentials", then "Create credentials" -> "OAuth client ID".
5 Select "Desktop app", enter whichever name you like, and click "Create". 5. Select "Desktop app", enter whichever name you like, and click "Create".
6. Click on the "Download JSON" icon next to your newly created client ID. 6. Click on the "Download JSON" icon next to your newly created client ID.
Save the JSON file under Save the JSON file under
``<WORKDIR>/credentials/google/client_secret.json``. ``<WORKDIR>/credentials/google/client_secret.json``.
7.1. If you're running the service on a desktop environment, then you 7. If you're running the service on a desktop environment, then you
can just start the application. A browser window will open and can just start the application. A browser window will open and
you'll be asked to authorize the application - you may be prompted you'll be asked to authorize the application - you may be prompted
with a warning because you are running a personal and potentially with a warning because you are running a personal and potentially
unverified application. After authorizing the application, the unverified application. After authorizing the application, the
process will save the credentials under process will save the credentials under
``<WORKDIR>/credentials/google/<list,of,scopes>.json`` and proceed ``<WORKDIR>/credentials/google/<list,of,scopes>.json`` and proceed
with the plugin initialization. with the plugin initialization.
7.2. If you're running the service on a headless environment, or you 8. If you're running the service on a headless environment, or you
prefer to manually generate the credentials file before copying to prefer to manually generate the credentials file before copying to
another machine, you can run the following command: another machine, you can run the following command:
.. code-block:: bash .. code-block:: bash
@ -56,12 +56,12 @@ class GoogleFitPlugin(GooglePlugin):
[--noauth_local_webserver] \ [--noauth_local_webserver] \
<WORKDIR>/credentials/google/client_secret.json <WORKDIR>/credentials/google/client_secret.json
When launched with ``--noauth_local_webserver``, the script will When launched with ``--noauth_local_webserver``, the script will
start a local webserver and print a URL that should be opened in start a local webserver and print a URL that should be opened in
your browser. After authorizing the application, you may be your browser. After authorizing the application, you may be
prompted with a code that you should copy and paste back to the prompted with a code that you should copy and paste back to the
script. Otherwise, if you're running the script on a desktop, a script. Otherwise, if you're running the script on a desktop, a
browser window will be opened automatically. browser window will be opened automatically.
""" """

36
platypush/plugins/google/mail/__init__.py
View file

@ -34,24 +34,24 @@ class GoogleMailPlugin(GooglePlugin):
4. Click on "Credentials", then "Create credentials" -> "OAuth client ID". 4. Click on "Credentials", then "Create credentials" -> "OAuth client ID".
5 Select "Desktop app", enter whichever name you like, and click "Create". 5. Select "Desktop app", enter whichever name you like, and click "Create".
6. Click on the "Download JSON" icon next to your newly created client ID. 6. Click on the "Download JSON" icon next to your newly created client ID.
Save the JSON file under Save the JSON file under
``<WORKDIR>/credentials/google/client_secret.json``. ``<WORKDIR>/credentials/google/client_secret.json``.
7.1. If you're running the service on a desktop environment, then you 7. If you're running the service on a desktop environment, then you
can just start the application. A browser window will open and can just start the application. A browser window will open and
you'll be asked to authorize the application - you may be prompted you'll be asked to authorize the application - you may be prompted
with a warning because you are running a personal and potentially with a warning because you are running a personal and potentially
unverified application. After authorizing the application, the unverified application. After authorizing the application, the
process will save the credentials under process will save the credentials under
``<WORKDIR>/credentials/google/<list,of,scopes>.json`` and proceed ``<WORKDIR>/credentials/google/<list,of,scopes>.json`` and proceed
with the plugin initialization. with the plugin initialization.
7.2. If you're running the service on a headless environment, or you 8. If you're running the service on a headless environment, or you
prefer to manually generate the credentials file before copying to prefer to manually generate the credentials file before copying to
another machine, you can run the following command: another machine, you can run the following command:
.. code-block:: bash .. code-block:: bash
@ -61,12 +61,12 @@ class GoogleMailPlugin(GooglePlugin):
[--noauth_local_webserver] \ [--noauth_local_webserver] \
<WORKDIR>/credentials/google/client_secret.json <WORKDIR>/credentials/google/client_secret.json
When launched with ``--noauth_local_webserver``, the script will When launched with ``--noauth_local_webserver``, the script will
start a local webserver and print a URL that should be opened in start a local webserver and print a URL that should be opened in
your browser. After authorizing the application, you may be your browser. After authorizing the application, you may be
prompted with a code that you should copy and paste back to the prompted with a code that you should copy and paste back to the
script. Otherwise, if you're running the script on a desktop, a script. Otherwise, if you're running the script on a desktop, a
browser window will be opened automatically. browser window will be opened automatically.
""" """