Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/threema-ch/app-remote-protocol
The protocol used for communicating between the Threema mobile apps and a remote application (e.g. Threema Web).
https://github.com/threema-ch/app-remote-protocol
protocol threema threema-web
Last synced: about 1 month ago
JSON representation
The protocol used for communicating between the Threema mobile apps and a remote application (e.g. Threema Web).
- Host: GitHub
- URL: https://github.com/threema-ch/app-remote-protocol
- Owner: threema-ch
- Created: 2018-11-14T13:44:39.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T14:19:56.000Z (8 months ago)
- Last Synced: 2024-04-23T20:38:26.520Z (8 months ago)
- Topics: protocol, threema, threema-web
- Language: Python
- Homepage: https://threema-ch.github.io/app-remote-protocol/
- Size: 403 KB
- Stars: 22
- Watchers: 8
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Threema App Remote Protocol (ARP)
This documentation contains the specification of the data exchange protocol
used between the Threema apps and a remote client (e.g. Threema Web).
## Generating HTML Docs
Requirements:
- Python 3.6+
Setup:
python3 -m venv venv
venv/bin/pip install -U -r requirements.txt
Run:
venv/bin/python generate.py
The static output is written to the `output/` directory.
## Schema Format
The schema is a custom YAML based format that can be parsed to generate HTML
docs. Descriptions and summaries may contain markdown (commonmark flavor)
markup.
## License
### Python Code (MIT)
Copyright © 2018-2024 Threema GmbH (https://threema.ch/).
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.
### Documentation Text (CC BY-SA 3.0)
Copyright © 2018-2024 Threema GmbH (https://threema.ch/).
This work is licensed under the [Creative Commons Attribution-ShareAlike 3.0
Unported License](https://creativecommons.org/licenses/by-sa/3.0/). To view a
copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or
send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.