Mercurial > p > roundup > code
annotate RELEASE.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 | fdcd7ef5bacf |
| children | de275ca660c5 |
| rev | line source |
|---|---|
| 1354 | 1 Building Releases |
| 2 ================= | |
|
98
16dcdab5ce70
Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
3 |
| 4807 | 4 Roundup is a pure Python application with no binary components. This file |
| 5 describes how to build a source release. To find out how to install | |
| 6 Roundup, read the doc/installation.txt file. | |
|
98
16dcdab5ce70
Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
7 |
| 4807 | 8 Roundup release checklist: |
|
98
16dcdab5ce70
Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
9 |
| 4807 | 10 1. Run unit tests! They should pass successfully. "./run_tests.py" |
|
4815
efa61cc8be67
RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents:
4809
diff
changeset
|
11 2. Update version |
|
efa61cc8be67
RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents:
4809
diff
changeset
|
12 CHANGES.txt |
|
efa61cc8be67
RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents:
4809
diff
changeset
|
13 roundup/__init__.py |
|
efa61cc8be67
RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents:
4809
diff
changeset
|
14 3. Update documentation |
|
efa61cc8be67
RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents:
4809
diff
changeset
|
15 doc/announcement.txt |
|
efa61cc8be67
RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents:
4809
diff
changeset
|
16 doc/upgrading.txt |
|
4835
5cd6b0014f34
RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents:
4834
diff
changeset
|
17 4. Update setup.py info is needed (contacts, classifiers, etc.), and |
|
5cd6b0014f34
RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents:
4834
diff
changeset
|
18 check that metadata is valid and long descriptions is proper reST: |
|
5cd6b0014f34
RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents:
4834
diff
changeset
|
19 python setup.py check --restructuredtext --metadata --strict |
|
5cd6b0014f34
RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents:
4834
diff
changeset
|
20 5. Clean out all *.orig, *.rej, .#* files from the source. |
|
5cd6b0014f34
RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents:
4834
diff
changeset
|
21 6. Remove previuos build files |
|
5cd6b0014f34
RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents:
4834
diff
changeset
|
22 python setup.py clean --all |
|
4809
80febeb6d897
RELEASE.txt: Update HTML doc paths
anatoly techtonik <techtonik@gmail.com>
parents:
4808
diff
changeset
|
23 7. Rebuild documentation in "share/doc/roundup/html" |
|
4834
8a4021713c6e
RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents:
4815
diff
changeset
|
24 python setup.py build_doc |
|
4487
5e9578d35d03
Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents:
4433
diff
changeset
|
25 8. python setup.py sdist --manifest-only |
|
5e9578d35d03
Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents:
4433
diff
changeset
|
26 9. Check the MANIFEST to make sure that any new files are included. If |
|
4834
8a4021713c6e
RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents:
4815
diff
changeset
|
27 they are not, edit MANIFEST.in to include them. For format docs see |
|
8a4021713c6e
RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents:
4815
diff
changeset
|
28 http://docs.python.org/2/distutils/sourcedist.html#manifest-template |
|
4487
5e9578d35d03
Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents:
4433
diff
changeset
|
29 10. python setup.py sdist |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1875
diff
changeset
|
30 (if you find sdist a little verbose, add "--quiet" to the end of the |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1875
diff
changeset
|
31 command) |
|
4834
8a4021713c6e
RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents:
4815
diff
changeset
|
32 11. Unpack the new dist file in /tmp then |
|
8a4021713c6e
RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents:
4815
diff
changeset
|
33 a) run_test.py |
|
8a4021713c6e
RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents:
4815
diff
changeset
|
34 b) demo.py |
|
1947
0e19e99075e3
fix #white in cgitb
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
35 with all available Python versions. |
|
4562
93b0b3f0085a
Remove some Subversion-specific references.
Eric S. Raymond <esr@thyrsus.com>
parents:
4527
diff
changeset
|
36 12. Assuming all is well tag the release in the version-control system. |
|
4834
8a4021713c6e
RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents:
4815
diff
changeset
|
37 13. Build binary packages |
|
8a4021713c6e
RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents:
4815
diff
changeset
|
38 python setup.py bdist_rpm |
|
8a4021713c6e
RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents:
4815
diff
changeset
|
39 python setup.py bdist_wininst |
|
8a4021713c6e
RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents:
4815
diff
changeset
|
40 14. Upload source distributive to PyPI |
|
8a4021713c6e
RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents:
4815
diff
changeset
|
41 python setup.py sdist upload --sign |
|
4835
5cd6b0014f34
RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents:
4834
diff
changeset
|
42 It should appear on http://pypi.python.org/pypi/roundup in no time. |
|
4487
5e9578d35d03
Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents:
4433
diff
changeset
|
43 15. Send doc/announcement.txt to python-announce@python.org and |
|
4277
9e1a91f3cf17
- Add roundup-devel@lists.sourceforge.net to announcement list.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4272
diff
changeset
|
44 roundup-users@lists.sourceforge.net and |
|
9e1a91f3cf17
- Add roundup-devel@lists.sourceforge.net to announcement list.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4272
diff
changeset
|
45 roundup-devel@lists.sourceforge.net |
|
4836
fdcd7ef5bacf
RELEASE.txt: +website update
anatoly techtonik <techtonik@gmail.com>
parents:
4835
diff
changeset
|
46 16. Refresh website. |
|
fdcd7ef5bacf
RELEASE.txt: +website update
anatoly techtonik <techtonik@gmail.com>
parents:
4835
diff
changeset
|
47 website/README.txt |
|
98
16dcdab5ce70
Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
48 |
| 1354 | 49 So, those commands in a nice, cut'n'pasteable form:: |
| 50 | |
|
3531
616244e247f4
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3106
diff
changeset
|
51 find . -name '*.orig' -exec rm {} \; |
|
616244e247f4
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3106
diff
changeset
|
52 find . -name '*.rej' -exec rm {} \; |
|
616244e247f4
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3106
diff
changeset
|
53 find . -name '.#*' -exec rm {} \; |
| 1354 | 54 python setup.py clean --all |
|
4835
5cd6b0014f34
RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents:
4834
diff
changeset
|
55 python setup.py check --restructuredtext --metadata --strict |
|
4487
5e9578d35d03
Document 'build_doc' step.
Stefan Seefeld <stefan@seefeld.name>
parents:
4433
diff
changeset
|
56 python setup.py build_doc |
| 1354 | 57 python setup.py sdist --manifest-only |
| 58 python setup.py sdist --quiet | |
|
2237
f624fc20f8fe
added capturing of stats
Richard Jones <richard@users.sourceforge.net>
parents:
2223
diff
changeset
|
59 python setup.py bdist_rpm |
|
f624fc20f8fe
added capturing of stats
Richard Jones <richard@users.sourceforge.net>
parents:
2223
diff
changeset
|
60 python setup.py bdist_wininst |
|
3588
503d4c10f1f8
pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents:
3531
diff
changeset
|
61 python setup.py register |
|
4261
d82cd44bea96
update BUILD
Richard Jones <richard@users.sourceforge.net>
parents:
4104
diff
changeset
|
62 python setup.py sdist upload --sign |
|
4501
588e5dbbb9fe
- document experience from release(s)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4487
diff
changeset
|
63 python2.5 setup.py bdist_wininst upload --sign |
|
98
16dcdab5ce70
Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
64 |
|
4261
d82cd44bea96
update BUILD
Richard Jones <richard@users.sourceforge.net>
parents:
4104
diff
changeset
|
65 (if the last two fail make sure you're using python2.5+) |
|
4501
588e5dbbb9fe
- document experience from release(s)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4487
diff
changeset
|
66 Note that python2.6 won't correctly create a bdist_wininst install on |
|
4527
079fdf9b8de1
fix build instructions
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4501
diff
changeset
|
67 Linux (it will produce a .exe with "linux" in the name). 2.7 still has |
|
079fdf9b8de1
fix build instructions
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4501
diff
changeset
|
68 this bug (Ralf) |
|
4501
588e5dbbb9fe
- document experience from release(s)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4487
diff
changeset
|
69 |
