# TelemetryDeckPy
[TelemetryDeck](https://telemetrydeck.com) is a privacy focuesd user analytics tool. **TelemetryDeckPy** is a small python package to send signals to TelemetryDeck in a pythonic way.
## Usage
```python
def main():
# Create a telemetrydeckpy object
telemetry = telemetrydeckpy.TelemetryDeck()
# and a telemetrydeckpy signal object based on
# the official documentation
# https://telemetrydeck.com/docs/ingest/v2/
signal = telemetrydeckpy.Signal('app_id', 'client_user', 'signal_type')
# and modify it to your own extend
signal.is_test_mode = True
signal.payload = {'pay': 'load'}
# send the signal
telemetry.send_signal(signal)
```
MIT License
Copyright (c) 2024 Thore D. Jahn
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Raw data
{
"_id": null,
"home_page": null,
"name": "telemetrydeckpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "telemetrydeck, api, tracking",
"author": "Thore D. Jahn",
"author_email": "python@kurzgedanke.me",
"download_url": "https://files.pythonhosted.org/packages/4a/9c/16505b0df0c9515b0948e3e51746f00c4f9515beb66a6589ceedd77e7822/telemetrydeckpy-1.0.0.tar.gz",
"platform": null,
"description": "# TelemetryDeckPy\n\n[TelemetryDeck](https://telemetrydeck.com) is a privacy focuesd user analytics tool. **TelemetryDeckPy** is a small python package to send signals to TelemetryDeck in a pythonic way.\n\n## Usage\n\n```python\ndef main():\n # Create a telemetrydeckpy object\n telemetry = telemetrydeckpy.TelemetryDeck()\n \n # and a telemetrydeckpy signal object based on \n # the official documentation\n # https://telemetrydeck.com/docs/ingest/v2/\n signal = telemetrydeckpy.Signal('app_id', 'client_user', 'signal_type')\n \n # and modify it to your own extend\n signal.is_test_mode = True\n signal.payload = {'pay': 'load'}\n\n # send the signal\n telemetry.send_signal(signal)\n```\nMIT License\n\nCopyright (c) 2024 Thore D. Jahn\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The TelemetryDeck API the pythonic way",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [
"telemetrydeck",
" api",
" tracking"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "42afb35e0961764197c6b3de6e80b49b94f579612c8368ca9698a918b5f46abc",
"md5": "129d31b5da91ac0ca0c210905f3ebaff",
"sha256": "18d7a9a2ed2d1b2650a319d551dd14d04355c8a12dbb5b5760a6eb90558a4a3d"
},
"downloads": -1,
"filename": "telemetrydeckpy-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "129d31b5da91ac0ca0c210905f3ebaff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 5103,
"upload_time": "2024-07-08T08:14:32",
"upload_time_iso_8601": "2024-07-08T08:14:32.225803Z",
"url": "https://files.pythonhosted.org/packages/42/af/b35e0961764197c6b3de6e80b49b94f579612c8368ca9698a918b5f46abc/telemetrydeckpy-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4a9c16505b0df0c9515b0948e3e51746f00c4f9515beb66a6589ceedd77e7822",
"md5": "074ac7409fc6a903d00cfeda9eaa316d",
"sha256": "58fa711727b6e3d3669bfb0cd8699e03c698c5f57161ead6282593bf72a8a9b6"
},
"downloads": -1,
"filename": "telemetrydeckpy-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "074ac7409fc6a903d00cfeda9eaa316d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 3425,
"upload_time": "2024-07-08T08:14:33",
"upload_time_iso_8601": "2024-07-08T08:14:33.831211Z",
"url": "https://files.pythonhosted.org/packages/4a/9c/16505b0df0c9515b0948e3e51746f00c4f9515beb66a6589ceedd77e7822/telemetrydeckpy-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-08 08:14:33",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "telemetrydeckpy"
}
JSON