Python 3 - Lernen und professionell anwenden

953

D.2

Ein Paket für die Veröffentlichung vorbereiten

D.2.3 Die Datei README.txt

Die Datei README.txt enthält eine Beschreibung des Moduls. Üblicherweise verwendet

man eine der vereinfachten Auszeichnungssprachen wie Markdown (

md) oder reStructured-

Text (

reST). Dann ist der Quelltext – so wie er ist – lesbar, aber zusätzlich kann die Webplatt-

form des Repositorys den Text interpretieren und in einer Webseite schön formatiert (mit

großen Überschriften etc.) präsentieren.

Der folgende Beispieltext ist in

reST geschrieben und liefert die Beschreibung des Moduls

in Abbildung D.1

Vergleichen Sie diesen Quelltext mit der Darstellung im PyPI (siehe Abbildung D.1). Tabelle

D.1 enthält einige Hinweise zur Formatierung mit reST. Eine umfassende Darstellung fin-

den Sie im WWW (z.B.

http://docutils.sourceforge.net/rst.html).

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.

=================================

Python Digital Multimeter (PyDMM)

=================================

**PyDMM** facilitates reading data from a digital

multimeter (DMM).

It works for example with *HP-90EPC*.

Typical usage looks like this::

import pydmm.pydmm as pd

try:

number = pd.read_dmm(port=myport, timeout=3)

print(number)

except:

print("Error")

Preparations

------------

- install pyserial

- install pydmm (this module)

- connect the DMM to the usb-port of your computer

- find out, which COM-port the device uses

- use the port number *myport* (COM3 has number 2) when calling

read_dmm()