Mercurial > p > roundup > code
annotate README.txt @ 5096:e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
Also adds new config.ini setting called indexer to select
indexer. See ``doc/upgrading.txt`` for details. Initial patch
done by David Wolever. Patch modified (see ticket or below for
changes), docs updated and committed.
I have an outstanding issue with test/test_indexer.py. I have to
comment out all imports and tests for indexers I don't have (i.e.
mysql, postgres) otherwise no tests run.
With that change made, dbm, sqlite (rdbms), xapian and whoosh indexes
are all passing the indexer tests.
Changes summary:
1) support native back ends dbm and rdbms. (original patch only fell
through to dbm)
2) Developed whoosh stopfilter to not index stopwords or words outside
the the maxlength and minlength limits defined in index_common.py.
Required to pass the extremewords test_indexer test. Also I
removed a call to .lower on the input text as the tokenizer I chose
automatically does the lowercase.
3) Added support for max/min length to find. This was needed to pass
extremewords test.
4) Added back a call to save_index in add_text. This allowed all but
two tests to pass.
5) Fixed a call to:
results = searcher.search(query.Term("identifier", identifier))
which had an extra parameter that is an error under current whoosh.
6) Set limit=None in search call for find() otherwise it only return
10 items. This allowed it to pass manyresults test
Also due to changes in the roundup code removed the call in
indexer_whoosh to
from roundup.anypy.sets_ import set
since we use the python builtin set.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sat, 25 Jun 2016 20:10:03 -0400 |
| parents | bbfc87ecfdf1 |
| children | 49761be4a931 |
| rev | line source |
|---|---|
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
1 ======================================================= |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
2 Roundup: an Issue-Tracking System for Knowledge Workers |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
3 ======================================================= |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
4 |
| 1639 | 5 INSTANT GRATIFICATION |
| 6 ===================== | |
| 7 | |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
8 The impatient may try Roundup immediately by running demo.py from |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
9 the source directory:: |
| 1639 | 10 |
|
1640
d0b29215aa44
pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents:
1639
diff
changeset
|
11 python demo.py |
| 1639 | 12 |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
13 This will create new tracker home in "demo" subdirectory and start |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
14 server. To reset demo instance:: |
|
1640
d0b29215aa44
pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents:
1639
diff
changeset
|
15 |
|
d0b29215aa44
pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents:
1639
diff
changeset
|
16 python demo.py nuke |
| 1639 | 17 |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
18 |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
19 Tracker Home |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
20 ============= |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
21 "Tracker Home" is main concept when starting with Roundup. It is |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
22 directory where all your tracker data is stored. This directory is |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
23 created every time when new tracker is initialized and includes |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
24 tracker configuration, database, template, schema and extensions. |
|
3646
3a9a6b98c6e6
note about where to run demo.py from
Richard Jones <richard@users.sourceforge.net>
parents:
1640
diff
changeset
|
25 |
|
3a9a6b98c6e6
note about where to run demo.py from
Richard Jones <richard@users.sourceforge.net>
parents:
1640
diff
changeset
|
26 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
27 Installation |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
28 ============ |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
29 Please see "doc/installation.txt" |
|
94
9cf5229397fc
name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
30 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
31 |
|
796
5324a28060ab
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
791
diff
changeset
|
32 Upgrading |
|
5324a28060ab
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
791
diff
changeset
|
33 ========= |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
34 Please see "doc/upgrading.txt" |
|
4092
4b0ddce43d08
migrate from MimeWriter to email
Richard Jones <richard@users.sourceforge.net>
parents:
3949
diff
changeset
|
35 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
36 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
37 Usage and Other Information |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
38 =========================== |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
39 Start with the index.txt file in the "doc" directory. These |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
40 documentation files are written in reStructedText, which can be |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
41 converted into HTML format. If you have Sphinx installed, you can |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
42 do this by running:: |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
43 |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
44 python setup.py build_doc |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
45 |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
46 Resulting HTML files will be in "share/doc/roundup/html" directory. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
47 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
48 |
|
4563
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
49 For Developers |
|
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
50 ============== |
|
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
51 To get started on development work, read the developers.txt file in |
|
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
52 the "doc" directory. |
|
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
53 |
|
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
54 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
55 License |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
56 ======= |
|
1409
8dc60d87ab42
Fixed a backlog of bug reports, and worked on python 2.3 compatibility:
Richard Jones <richard@users.sourceforge.net>
parents:
1071
diff
changeset
|
57 See COPYING.txt |
