Ansgar
5103a9659e
do not explicitly inherit from `object` in class definitions
|
3 years ago | |
|---|---|---|
| .. | ||
| queries | 4 years ago | |
| README | 7 years ago | |
| __init__.py | 4 years ago | |
| dakweb.wsgi | 10 years ago | |
| dakwebserver.py | 4 years ago | |
| webregister.py | 3 years ago | |
README
We are happy to add features to dakweb if you have a need for them.
Here are a few tips to help you get started on creating a dakweb patch:
1. dakweb is implemented in Python, using the bottle web microframework and the
sqlalchemy ORM (object relational mapper).
In a nutshell, bottle allows us to expose Python functions via
HTTP. Parameters are automatically taken from the @bottle.route function
annotation and passed to the function.
For upstream documentation, see:
https://bottlepy.org/docs/dev/
http://www.sqlalchemy.org/
When browsing upstream documentation, keep in mind that we are using the
versions installed on mirror.ftp-master.debian.org, which is usually running
Debian stable. In other words: the latest documentation might not be
applicable yet.
2. The bulk of adding a new query is coming up with the actual database query
(as opposed to the plumbing). To get fast turn-around times while developing,
you can use the ipython REPL:
% ssh mirror.ftp-master.debian.org
mirror % cd /srv/ftp-master.debian.org/dak/
mirror % PYTHONPATH=. ipython
ipython % from daklib.dbconn import *
ipython % s = DBConn().session()
Then, to evaluate a query, construct it and call the all method, e.g.:
ipython % s.query(DBBinary.package, DBSource.source, SourceMetadata.value).join(DBSource).join(SourceMetadata).join(MetadataKey).filter(MetadataKey.key == 'Go-Import-Path').group_by(DBBinary.package, DBSource.source, SourceMetadata.value).all()
Here are a few tips to help you get started on creating a dakweb patch:
1. dakweb is implemented in Python, using the bottle web microframework and the
sqlalchemy ORM (object relational mapper).
In a nutshell, bottle allows us to expose Python functions via
HTTP. Parameters are automatically taken from the @bottle.route function
annotation and passed to the function.
For upstream documentation, see:
https://bottlepy.org/docs/dev/
http://www.sqlalchemy.org/
When browsing upstream documentation, keep in mind that we are using the
versions installed on mirror.ftp-master.debian.org, which is usually running
Debian stable. In other words: the latest documentation might not be
applicable yet.
2. The bulk of adding a new query is coming up with the actual database query
(as opposed to the plumbing). To get fast turn-around times while developing,
you can use the ipython REPL:
% ssh mirror.ftp-master.debian.org
mirror % cd /srv/ftp-master.debian.org/dak/
mirror % PYTHONPATH=. ipython
ipython % from daklib.dbconn import *
ipython % s = DBConn().session()
Then, to evaluate a query, construct it and call the all method, e.g.:
ipython % s.query(DBBinary.package, DBSource.source, SourceMetadata.value).join(DBSource).join(SourceMetadata).join(MetadataKey).filter(MetadataKey.key == 'Go-Import-Path').group_by(DBBinary.package, DBSource.source, SourceMetadata.value).all()