PiModules/code/python/package/README.txt at 6de7a69e3dbc104f014b4ce3ea92b4f7e5456404 · modmypi/PiModules · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

PiModules Python Package
========================

This directory contains the installation scripts and the PiModules(R) Python package that supports PiModules products.

Installation
------------

First you need to install a couple of Python dependencies.  Install python3-pip like this:

	sudo apt-get install python3-pip

Then install both `jinja2` and `xmltodict` like this:

	sudo pip3 install jinja2
	sudo pip3 install xmltodict

Both of the above libraries are used in the sending of email alerts by the file-safe shutdown
daemon.

Now install the pimodules package:

	sudo python3 setup.py install

You can record what files are installed by the above process by running it like this:

	sudo python3 setup.py install --record <filename>

Where <filename> will be a text file containing one line per file installed by the process.

If the `--record` function was used, files can be easily uninstalled in this way:

	cat <filename> | xargs sudo rm

Where `<filename>` was the name of the file recorded in the installation process.

Package Contents
----------------

* daemon.py

Generic Python `daemon` code used by the `picofssd` script, the UPS PIco file-safe shutdown daemon.

Directory Contents
------------------

* ChangeLog

Record of changes to this package and it's files.

* LICENSE

Text of the Gnu General Public License version 3.

* MANIFEST.in

MANIFEST template used by Python setup tools.

* pimodules/

The code is in here.

* README.txt

This file.

* setup.py

Installation file, see `README.md` in the directory above this one.