linse/frappy
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
frappy/doc/notes.md
Enrico Faulhaber d3c430e1b9 Devices infrastructure and minimal server 
starts and creates (server-side) devices
no daemonizing and servicing yet

hint: try starting:
$ bin/server.py -v start

Change-Id: I6ac7a78dfff309a459cc0338a8d0d319ee72ada5
2016-06-22 17:21:18 +02:00

1.2 KiB
Raw Blame History

No installation required or recommended.

everything runs directly from the checkout.

you need:

  • python2.7.*
  • pip
  • linux OS (Mac may work as well)

install requirements with pip: $ sudo pip install -r requirements.txt

to execute a program, prefix its name with bin/, e.g.: $ bin/make_doc.py $ bin/server.py start test

a testsuite is planned but nothing is there yet.

structure

  • bin contains the executables (make_doc.py, server.py)
  • doc is the root node of the docu (see index.md)
  • etc contains the configurations for the server(s) and devices
  • html contains the docu after make_doc.py was run
  • log contains some (hopefully) log output from the servers
  • pid contains pidfiles if a server is running
  • src contains the python source
    • src/client: client specific stuff (proxy)
    • src/devices: devices to be used by the server (and exported via SECoP)
    • src/lib: helper stuff (startup, pidfiles, etc)
    • src/protocol: protocol specific stuff
    • src/errors.py: internal errors
    • src/server.py: device-managing part of the server (transport is in src/protocol/transport)
    • src/validators.py: validators used by the devices. may be moved to src/protocol

THERE IS STILL MUCH WORK TO DO!