annotate README.creole @ 17:adca5b3780d2

Add collecting no-prio issues. Restructure. * Move usage examples from collect_issues.py to examples/. Also add a section about this to the readme. This should make it easier to understand how it all works together. As we have two examples now, hardcode the database filenames. * Add a function to create the necessary database command from a list of columns. This makes it easier to work with tracker that have customized their priorities, * Add an example how to collect no-prio issues in a database. Note that the display part is not included. * Cleanup roundup_content_data by removing db file name suggestions and unused "reference db" command. This could be re-added for specific installations if they need it, however it probably should be separated as configuration.
author Bernhard Reiter <bernhard@intevation.de>
date Mon, 09 Jul 2018 12:28:28 +0200
parents 5c24c116ba1f
children 3bb3d9a9f1b7
rev   line source
4
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
1 = Roundup Issue Collector
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
2
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
3 Grab and display data from a http://roundup-tracker.org/ instance.
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
4
16
5c24c116ba1f Improve phrasing in README.
Bernhard Reiter <bernhard@intevation.de>
parents: 15
diff changeset
5 It is Free Software, check out the file headers.
4
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
6
17
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
7 === Example
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
8 Run ./demo.py from a roundup-tracker to have a running tracker.
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
9
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
10 {{{
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
11 cp examples/collect_demo1.py c1.py
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
12 ./c1.py
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
13 # create or change some issues
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
14 ./c1.py
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
15
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
16 # to inspect the database contents
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
17 sqlite3 demo1.db 'select * from issues;'
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
18
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
19 ./display_issues_demo.py >demo1.html
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
20 chromium demo1.html
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
21 }}}
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
22
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
23
4
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
24 === Notes
17
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
25 examples/collect_demo2.py builds database column names dynamically
adca5b3780d2 Add collecting no-prio issues. Restructure.
Bernhard Reiter <bernhard@intevation.de>
parents: 16
diff changeset
26 and tracks issues with priorities. The display part is still missing.
4
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
27
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
28 When migrating to 3:99c68ebfb3b9, Nov 30 17:46:22 2015
15
d0c439d1e833 Prepare for tracker entries without priority.
Bernhard Reiter <bernhard@intevation.de>
parents: 10
diff changeset
29 you need to add the print statements for the content-type header
4
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
30 to all of your cgi scripts.
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
31
10
efe7ed655c02 Hint that bottledash has a fork.
Bernhard Reiter <bernhard@intevation.de>
parents: 4
diff changeset
32 Bottledash may have a fork
efe7ed655c02 Hint that bottledash has a fork.
Bernhard Reiter <bernhard@intevation.de>
parents: 4
diff changeset
33 https://wald.intevation.org/hg/bottledash/file/tip/modules/web_view
efe7ed655c02 Hint that bottledash has a fork.
Bernhard Reiter <bernhard@intevation.de>
parents: 4
diff changeset
34
4
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
35 === Prerequisites
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
36
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
37 Python v3, with build-in sqlite3 module.
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
38
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
39 === Included
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
40
15
d0c439d1e833 Prepare for tracker entries without priority.
Bernhard Reiter <bernhard@intevation.de>
parents: 10
diff changeset
41 http://d3js.org/ initially used with 3.5.5
4
0b65eb9ecb79 Cleanup: Added README.creole. Removed old file.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
42 """Library released under BSD license. Copyright 2015 Mike Bostock."
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)