The development environment is
Although it is possible to use editors other than emacs for the current task, the missing highlighting support and tag navigation make comprehension and work quite hard.
The task can be completed in a terminal with ssh(1) access to sw-amt.ws. It is perfectly possible to use PuTTY under windows.
A more comfortable graphical environment is available with a VNC viewer (e.g. UltraVNC) via SSH-Tunnel. MacOS X comes with a builtin VNC client, press ⌘-k (CMD-k) in Finder and enter vnc://host:port.
Since the project is under version control, it is also possible to clone the repository and complete the project entirely off-site.
Access sw-amt.ws with ssh(1) in terminal.
Initialize workpackage directory from repository:
hg clone http://@user@:@passwd@@sw-amt.ws/kallithea/applicants/@user@ workpackage
Initialize documentation in workpackage directory:
cd workpackage
sda init Workpackage
Commit initial revision to version control system (VCS):
hg add
hg commit -m 'README.txt: project documenatation initial revision'
hg push
Create database workpackage.db:
snn --key sqlite_db_base --value workpackage workpackage.sql
emacs workpackage.sql
# create table ...
sqlite3 workpackage.db <workpackage.sql
Commit initial revision to VCS:
hg add workpackage.sql
hg commit -m 'workpackage.sql: define tables'
hg push
Generate workpackage_db module:
sqa-schema.py --pyjsmo-schema 'sqlite:///workpackage.db' > 'workpackage_db.py'
emacs 'workpackage_db.py'
Commit initial revision to VCS:
hg add workpackage_db.py
hg commit -m 'workpackage_db.py: define sqlalchemy ORM tables'
hg push
Note
Use sqlalchemy ORM classes from
workpackage_db to access the database tables. Do
not use low-level SQL statements based on PEP 249 –
Python Database API Specification v2.0.
Build and view documentation:
sda make
xdg-open https://sw-amt.ws/@user@/doc/html
Accessing the generated documentation at https://sw-amt.ws/@user@/doc/html requires the username @user@ and the same password as for the VNC server.
Examples for diagrams and pointers to definitions can be found in Documentation Standard.
Note
The documentation ist embedded into a framework based on Sphinx. There is no need to use any facilities provided by the framework. The documentation goes between the lines
.. >>CODD Introduction
-- DOCUMENTATION GOES HERE --
.. >>CODD Notes
Design workpackage module in README.txt.
Create bottle app. In function run() start HTTP server on
port supplied with option –port, default: 50@offset@.
On index page display buttons Fill and Clear. Also display all persons and their car(s) in a table.
Use PlantUML UML diagrams for design:
Commit changes into VCS:
hg commit -m 'README.txt: program design'
hg push
Submit for review.
Implement workpackage module:
snn workpackage.py
emacs 'workpackage.py'
Commit initial revision and meaningful increments to VCS.
Note
missing python packages can be installed in a
virtualenv or with pip install --user, e.g.:
pip install --user bottle
Serve workpackage application and view it:
python workpackage.py
xdg-open https://sw-amt.ws/@user@/persons
The URL https://sw-amt.ws/@user@/persons is served by Apache with a reverse proxy configuration to http://localhost:50@offset@
Complete documentation of project workpackage:
emacs 'README.txt'
Create a sqlite3 database from an SQL file
workpackage.sql, with tables person (see
table 3.1) and car (see table 3.2):
Note
Do not declare the foreign key relation for driver_id explicitely.
| column | type | attributes |
|---|---|---|
| _id | INTEGER | AUTOINCREMENT, PRIMARY KEY |
| name | TEXT | |
| first_name | TEXT |
| column | type | attributes |
|---|---|---|
| _id | INTEGER | AUTOINCREMENT, PRIMARY KEY |
| manufacturer | TEXT | |
| model | TEXT | |
| driver_id | INTEGER |