Skip to content

Commit 9377510

Browse files
committed
Add docs
1 parent 4bbcb80 commit 9377510

4 files changed

Lines changed: 59 additions & 0 deletions

File tree

CHANGELOG.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Changelog
2+
=========
3+
4+
0.0.1 (2019-12-xx)
5+
------------------
6+
7+
- Initial release

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2019 Fabian Affolter <fabian@affolter-engineering.ch>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

MANIFEST.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include LICENSE

README.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
python-dingz
2+
============
3+
4+
Python API for interacting with `Dingz <https://dingz.ch>`_ devices.
5+
6+
This module is not official, developed, supported or endorsed by Dingz AG.
7+
For questions and other inquiries, use the issue tracker in this repo please.
8+
9+
Requirements
10+
------------
11+
12+
You need to have `Python 3 <https://www.python.org>`_ installed.
13+
14+
- `Dingz <https://dingz.ch>`_ device
15+
- Network connection
16+
- Devices connected to your network
17+
18+
Installation
19+
------------
20+
21+
The package is available in the `Python Package Index <https://pypi.python.org/>`_ .
22+
23+
.. code:: bash
24+
25+
$ pip install python-dingz
26+
27+
License
28+
-------
29+
30+
``python-dingz`` is licensed under MIT, for more details check LICENSE.

0 commit comments

Comments
 (0)