wis2downloader

Name	wis2downloader JSON
Version	0.3.1 JSON
	download
home_page	None
Summary	Python package to manage subscriptions and downloads from the WIS2.0
upload_time	2024-08-22 17:49:35
maintainer	Rory Burke
docs_url	None
author	Rory Burke
requires_python	>=3.8
license	Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
keywords	wis2.0 mqtt subscribe download
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

# The WIS2 Downloader
## The backend tool for subscribing to the latest data on the WIS2 network

<a href="https://github.com/wmo-im/wis2downloader/blob/main/LICENSE" alt="License" ><img src="https://img.shields.io/badge/License-Apache_2.0-blue" alt="License Badge"></img></a>
[![Super-Linter](https://github.com/wmo-im/wis2downloader/actions/workflows/test-code-quality.yml/badge.svg)](https://github.com/marketplace/actions/super-linter)
![Unit-Tests](https://github.com/wmo-im/wis2downloader/actions/workflows/unit-tests.yml/badge.svg)

</div>

The WIS2 Downloader is a Flask-based Python application that allows you to connect to a WIS2 Global Broker, manage subscriptions to topic hierarchies, and configure their associated download directories.

## Features

- **Dynamic Subscription Management**: Quickly add or remove subscriptions ad hoc without needing to restart the service or change configuration files.
- **Monitor Download Statistics**: Access the Prometheus metrics through the `/metrics` endpoint, ideal for <a href="https://prometheus.io/docs/visualization/grafana/">Grafana visualization</a>.
- **Multi-Threading Support**: Configure the number of download workers for more efficient data downloading.

## Getting Started

### 1. Installation

```bash
python -m pip install wis2downloader
```

### 2. Configuration

Create a file `config.json` in your local directory that conforms with the following schema:

```yaml
schema:
type: object
properties:
base_url:
type: string
description:
Base URL for the wis2downloader service.
example: http://localhost:5050
broker_hostname:
type: string
description: The hostname of the global broker to subscribe to.
example: globalbroker.meteo.fr
broker_password:
type: string
description: The password to use when connecting to the specified global broker.
example: everyone
broker_port:
type: number
description: The port the global broker is using for the specified protocol.
example: 443
broker_protocol:
type: string
description: The protocol (websockets or tcp) to use when connecting to the global broker.
example: websockets
broker_username:
type: string
description: The username to use when connecting to the global broker.
example: everyone
download_workers:
type: number
description: The number of download worker threads to spawn.
example: 1
download_dir:
type: string
description: The path to download data to on the server/computer running the wis2downloader.
example: ./downloads
flask_host:
type: string
description: Network interface on which flask should listen when run in dev mode.
example: 0.0.0.0
flask_port:
type: number
description: The port on which flask should listen when run in dev mode.
example: 5050
log_level:
type: string
description: Log level to use
example: DEBUG
log_path:
type: string
description: Path to write log files to.
example: ./logs
min_free_space:
type: number
description:
Minimum free space (GB) to leave on download volume / disk after download.
Files exceeding limit will not be saved.
example: 10
save_logs:
type: boolean
description: Write log files to disk (true) or stdout (false)
example: false
mqtt_session_info:
type: string
description:
File to save session information (active subscriptions and MQTT client id) to.
Used to persist subscriptions on restart.
example: mqtt_session.json
validate_topics:
type: boolean
description: Whether to validate the specified topic against the published WIS2 topic hierarchy.
example: true
```

An example is given below:

```json
{
"base_url": "http://localhost:5050",
"broker_hostname": "globalbroker.meteo.fr",
"broker_password": "everyone",
"broker_port": 443,
"broker_protocol": "websockets",
"broker_username": "everyone",
"download_workers": 1,
"download_dir": "downloads",
"flask_host": "0.0.0.0",
"flask_port": 5050,
"log_level": "DEBUG",
"log_path": "logs",
"min_free_space": 10,
"mqtt_session_info" : "mqtt_session.json",
"save_logs": false,
"validate_topics": true
}
```

### 3. Running

1. Set an environment variable specifying the path to the config.json file.

*Linux (bash)*
```bash
export WIS2DOWNLOADER_CONFIG=<path_to_your_config_file>
```

*Windows (Command Prompt)*
```shell
set WIS2DOWNLOADER_CONFIG=<path_to_your_config_file>
```

*Windows (PowersShell)*
```shell
$env:WIS2DOWNLOADER_CONFIG = <path_to_your_config_file>
```

2. Start the downloader

*Dev mode (Windows and Linux)*

```bash
wis2downloader
```

*Using gunicorn (Linux only)*
```bash
gunicorn --bind 0.0.0.0:5050 -w 1 wis2downloader.app:app
```

**Note**: Only one worker is supported due to the downloader spawning additional threads and persistence of MQTT
connections.

The Flask application should now be running. If you need to stop the application,
you can do so in the terminal with `Ctrl+C`.

## Maintaining and Monitoring Subscriptions

The API defintion of the downloader can be found at the `/swagger` endpoint, when run locally see
[http://localhost:5050/swagger]. this includes the ability to try out the different endpoints.

### Adding subscriptions
Subscriptions can be added via a POST request to the `/subscriptions` endpoint.
The request body should be JSON-encoded and adhere to the following schema:

```yaml
schema:
type: object
properties:
topic:
type: string
description: The WIS2 topic to subscribe to
example: cache/a/wis2/+/data/core/weather/surface-based-observations/#
target:
type: string
description: Sub directory to save data to
example: surface-obs
required:
- topic
```

In this example all notifications published to the `surface-based-observations` topic from any WIS2 centre will be
subscribed to, with the downloaded data written to the `surface-obs` subdirectory of the `download_dir`.

Notes:
1. If the `target` is not specified it will default to the topic the data are published on.
1. The `+` wildcard is used to specify any match at a single level, matching as WIS2 centre in the above example.
1. The `#` wildcard matches any topic at or below the level it occurs. In the above example any topic published below
cache/a/wis2/+/data/core/weather/surface-based-observations will be matched.

#### Example CURL command to add subscription

```bash
curl -X 'POST' \
'http://127.0.0.1:5050/subscriptions' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"topic": "cache/a/wis2/+/data/core/weather/surface-based-observations/#",
"target": "surface-obs"
}'
```

### Deleting subscriptions
Subscriptions are deleted via a DELETE request to the `/subscriptions/{topic}` endpoint where `{topic}` is the topic
to unsubscribe from.

#### Example CURL command to delete subscription

```bash
curl -X DELETE http://localhost:5050/subscriptions/cache/a/wis2/%2B/data/core/weather/%23
```

This cancels the `cache/a/wis2/+/data/core/weather/#` subscription. Note the need to URL encode the `+` (`%2B`)
and `#` (`%23`) symbols.

### Listing subscriptions
Current subscriptions can listed via a GET request to `/subscriptions` endpoint.

#### Example CURL command to list subscriptions

```bash
curl http://localhost:5050/subscriptions
```

The list of active subscriptions should be returned as a JSON object.

### Viewing download metrics
Prometheus metrics for the downloader are found via a GET request to the `/metrics` endpoint.

#### Example CURL command to view download metrics

```bash
curl http://localhost:5050/metrics
```

## Bugs and Issues

All bugs, enhancements and issues are managed on [GitHub](https://github.com/wmo-im/wis2downloader/issues).

## Contact

* [Rory Burke](https://github.com/RoryPTB)
* [David Berry](https://github.com/david-i-berry)

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "wis2downloader",
    "maintainer": "Rory Burke",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "\"David I. Berry\" <dberry@wmo.int>",
    "keywords": "WIS2.0, MQTT, subscribe, download",
    "author": "Rory Burke",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/8d/e9/9052d96118a6a8592babb6da6f55ba7c20c1ee59b92f622da9d0a7bed013/wis2downloader-0.3.1.tar.gz",
    "platform": null,
    "description": "# The WIS2 Downloader\n## The backend tool for subscribing to the latest data on the WIS2 network\n\n<div align=\"center\">\n\n  <a href=\"https://github.com/wmo-im/wis2downloader/blob/main/LICENSE\" alt=\"License\" ><img src=\"https://img.shields.io/badge/License-Apache_2.0-blue\" alt=\"License Badge\"></img></a>\n  [![Super-Linter](https://github.com/wmo-im/wis2downloader/actions/workflows/test-code-quality.yml/badge.svg)](https://github.com/marketplace/actions/super-linter)\n  ![Unit-Tests](https://github.com/wmo-im/wis2downloader/actions/workflows/unit-tests.yml/badge.svg)\n\n</div>\n\nThe WIS2 Downloader is a Flask-based Python application that allows you to connect to a WIS2 Global Broker, manage subscriptions to topic hierarchies, and configure their associated download directories.\n\n## Features\n\n- **Dynamic Subscription Management**: Quickly add or remove subscriptions ad hoc without needing to restart the service or change configuration files.\n- **Monitor Download Statistics**: Access the Prometheus metrics through the `/metrics` endpoint, ideal for <a href=\"https://prometheus.io/docs/visualization/grafana/\">Grafana visualization</a>.\n- **Multi-Threading Support**: Configure the number of download workers for more efficient data downloading.\n\n## Getting Started\n\n### 1. Installation\n\n```bash\npython -m pip install wis2downloader\n```\n\n### 2. Configuration\n\nCreate a file `config.json` in your local directory that conforms with the following schema:\n\n```yaml\nschema:\n  type: object\n  properties:\n    base_url:\n      type: string\n      description:\n        Base URL for the wis2downloader service.\n      example: http://localhost:5050\n    broker_hostname:\n      type: string\n      description: The hostname of the global broker to subscribe to.\n      example: globalbroker.meteo.fr\n    broker_password:\n      type: string\n      description: The password to use when connecting to the specified global broker.\n      example: everyone\n    broker_port:\n      type: number\n      description: The port the global broker is using for the specified protocol.\n      example: 443\n    broker_protocol:\n      type: string\n      description: The protocol (websockets or tcp) to use when connecting to the global broker.\n      example: websockets\n    broker_username:\n      type: string\n      description: The username to use when connecting to the global broker.\n      example: everyone\n    download_workers:\n      type: number\n      description: The number of download worker threads to spawn.\n      example: 1\n    download_dir:\n      type: string\n      description: The path to download data to on the server/computer running the wis2downloader.\n      example: ./downloads\n    flask_host:\n      type: string\n      description: Network interface on which flask should listen when run in dev mode.\n      example: 0.0.0.0\n    flask_port:\n      type: number\n      description: The port on which flask should listen when run in dev mode.\n      example: 5050\n    log_level:\n      type: string\n      description: Log level to use\n      example: DEBUG\n    log_path:\n      type: string\n      description: Path to write log files to.\n      example: ./logs\n    min_free_space:\n      type: number\n      description:\n        Minimum free space (GB) to leave on download volume / disk after download.\n        Files exceeding limit will not be saved.\n      example: 10\n    save_logs:\n      type: boolean\n      description: Write log files to disk (true) or stdout (false)\n      example: false\n    mqtt_session_info:\n      type: string\n      description:\n        File to save session information (active subscriptions and MQTT client id) to.\n        Used to persist subscriptions on restart.\n      example: mqtt_session.json\n    validate_topics:\n      type: boolean\n      description: Whether to validate the specified topic against the published WIS2 topic hierarchy.\n      example: true\n```\n\nAn example is given below:\n\n```json\n{\n    \"base_url\": \"http://localhost:5050\",\n    \"broker_hostname\": \"globalbroker.meteo.fr\",\n    \"broker_password\": \"everyone\",\n    \"broker_port\": 443,\n    \"broker_protocol\": \"websockets\",\n    \"broker_username\": \"everyone\",\n    \"download_workers\": 1,\n    \"download_dir\": \"downloads\",\n    \"flask_host\": \"0.0.0.0\",\n    \"flask_port\": 5050,\n    \"log_level\": \"DEBUG\",\n    \"log_path\": \"logs\",\n    \"min_free_space\": 10,\n    \"mqtt_session_info\" : \"mqtt_session.json\",\n    \"save_logs\": false,\n    \"validate_topics\": true\n}\n```\n\n### 3. Running\n\n1. Set an environment variable specifying the path to the config.json file.\n\n*Linux (bash)*\n```bash\nexport WIS2DOWNLOADER_CONFIG=<path_to_your_config_file>\n```\n\n*Windows (Command Prompt)*\n```shell\nset WIS2DOWNLOADER_CONFIG=<path_to_your_config_file>\n```\n\n*Windows (PowersShell)*\n```shell\n$env:WIS2DOWNLOADER_CONFIG = <path_to_your_config_file>\n```\n\n2. Start the downloader\n\n*Dev mode (Windows and Linux)*\n\n```bash\nwis2downloader\n```\n\n*Using gunicorn (Linux only)*\n```bash\ngunicorn --bind 0.0.0.0:5050 -w 1 wis2downloader.app:app\n```\n\n**Note**: Only one worker is supported due to the downloader spawning additional threads and persistence of MQTT\nconnections.\n\nThe Flask application should now be running. If you need to stop the application,\n you can do so in the terminal with `Ctrl+C`.\n\n## Maintaining and Monitoring Subscriptions\n\nThe API defintion of the downloader can be found at the `/swagger` endpoint, when run locally see\n[http://localhost:5050/swagger]. this includes the ability to try out the different endpoints.\n\n### Adding subscriptions\nSubscriptions can be added via a POST request to the `/subscriptions` endpoint.\nThe request body should be JSON-encoded and adhere to the following schema:\n\n```yaml\nschema:\n  type: object\n  properties:\n    topic:\n      type: string\n      description: The WIS2 topic to subscribe to\n      example: cache/a/wis2/+/data/core/weather/surface-based-observations/#\n    target:\n      type: string\n      description: Sub directory to save data to\n      example: surface-obs\n  required:\n    - topic\n```\n\nIn this example all notifications published to the `surface-based-observations` topic from any WIS2 centre will be\n subscribed to, with the downloaded data written to the `surface-obs` subdirectory of the `download_dir`.\n\nNotes:\n1. If the `target` is not specified it will default to the topic the data are published on.\n1. The `+` wildcard is used to specify any match at a single level, matching as WIS2 centre in the above example.\n1. The `#` wildcard matches any topic at or below the level it occurs. In the above example any topic published below\n cache/a/wis2/+/data/core/weather/surface-based-observations will be matched.\n\n#### Example CURL command to add subscription\n\n```bash\ncurl -X 'POST' \\\n  'http://127.0.0.1:5050/subscriptions' \\\n  -H 'accept: application/json' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\n      \"topic\": \"cache/a/wis2/+/data/core/weather/surface-based-observations/#\",\n      \"target\": \"surface-obs\"\n  }'\n```\n\n### Deleting subscriptions\nSubscriptions are deleted via a DELETE request to the `/subscriptions/{topic}` endpoint where `{topic}` is the topic\n to unsubscribe from.\n\n#### Example CURL command to delete subscription\n\n```bash\ncurl -X DELETE http://localhost:5050/subscriptions/cache/a/wis2/%2B/data/core/weather/%23\n```\n\nThis cancels the `cache/a/wis2/+/data/core/weather/#` subscription. Note the need to URL encode the `+` (`%2B`)\n and `#` (`%23`) symbols.\n\n### Listing subscriptions\nCurrent subscriptions can listed via a GET request to `/subscriptions` endpoint.\n\n#### Example CURL command to list subscriptions\n\n```bash\ncurl http://localhost:5050/subscriptions\n```\n\nThe list of active subscriptions should be returned as a JSON object.\n\n### Viewing download metrics\nPrometheus metrics for the downloader are found via a GET request to the `/metrics` endpoint.\n\n#### Example CURL command to view download metrics\n\n```bash\ncurl http://localhost:5050/metrics\n```\n\n## Bugs and Issues\n\nAll bugs, enhancements and issues are managed on [GitHub](https://github.com/wmo-im/wis2downloader/issues).\n\n## Contact\n\n* [Rory Burke](https://github.com/RoryPTB)\n* [David Berry](https://github.com/david-i-berry)\n",
    "bugtrack_url": null,
    "license": "Apache License Version 2.0, January 2004 http://www.apache.org/licenses/  TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION  1. Definitions.  \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.  \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.  \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.  \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License.  \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.  \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.  \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).  \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.  \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\"  \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.  2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.  3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.  4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:  (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and  (b) You must cause any modified files to carry prominent notices stating that You changed the files; and  (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and  (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.  You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.  5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.  6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.  7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.  8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.  9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.  END OF TERMS AND CONDITIONS  APPENDIX: How to apply the Apache License to your work.  To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives.  Copyright [yyyy] [name of copyright owner]  Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ",
    "summary": "Python package to manage subscriptions and downloads from the WIS2.0",
    "version": "0.3.1",
    "project_urls": null,
    "split_keywords": [
        "wis2.0",
        " mqtt",
        " subscribe",
        " download"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "df38495a7603d65cc60c05bfa6dfe23b71457dedd39f595d8fbf87ba4a899ed9",
                "md5": "59aa4c603aabf40b350fed3c770c6730",
                "sha256": "b207ae13ab06ac723c032195a1228b0e5fab43468a555516403b99b582f3a960"
            },
            "downloads": -1,
            "filename": "wis2downloader-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "59aa4c603aabf40b350fed3c770c6730",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 28981,
            "upload_time": "2024-08-22T17:49:33",
            "upload_time_iso_8601": "2024-08-22T17:49:33.652856Z",
            "url": "https://files.pythonhosted.org/packages/df/38/495a7603d65cc60c05bfa6dfe23b71457dedd39f595d8fbf87ba4a899ed9/wis2downloader-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8de99052d96118a6a8592babb6da6f55ba7c20c1ee59b92f622da9d0a7bed013",
                "md5": "19cc2591c6e6d3bd6c086d66e873fa28",
                "sha256": "b7fb0eb3ef9e656f580250893a0ff31187c82cbdc3ed96784ca5b86c61bfa7ed"
            },
            "downloads": -1,
            "filename": "wis2downloader-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "19cc2591c6e6d3bd6c086d66e873fa28",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 28112,
            "upload_time": "2024-08-22T17:49:35",
            "upload_time_iso_8601": "2024-08-22T17:49:35.091523Z",
            "url": "https://files.pythonhosted.org/packages/8d/e9/9052d96118a6a8592babb6da6f55ba7c20c1ee59b92f622da9d0a7bed013/wis2downloader-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-22 17:49:35",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "wis2downloader"
}

Rory Burke