[Python-modules-commits] [python-xapian-haystack] 01/05: importing python-xapian-haystack_2.1.0.orig.tar.gz
Michael Fladischer
fladi at moszumanska.debian.org
Mon Mar 20 07:11:54 UTC 2017
This is an automated email from the git hooks/post-receive script.
fladi pushed a commit to branch master
in repository python-xapian-haystack.
commit 9a3a35f65f69e9eb7359b82f6bd2bb938e9a56c4
Author: Michael Fladischer <FladischerMichael at fladi.at>
Date: Sun Mar 19 20:29:39 2017 +0100
importing python-xapian-haystack_2.1.0.orig.tar.gz
---
.coveragerc | 11 +
.gitignore | 6 +
.travis.yml | 68 ++
AUTHORS | 31 +
LICENSE | 280 +++++
MANIFEST.in | 3 +
README.rst | 139 +++
install_xapian.sh | 54 +
requirements.txt | 2 +
setup.py | 33 +
tests/xapian_settings.py | 16 +
tests/xapian_tests/__init__.py | 0
tests/xapian_tests/models.py | 41 +
tests/xapian_tests/search_indexes.py | 162 +++
tests/xapian_tests/tests/__init__.py | 0
tests/xapian_tests/tests/test_backend.py | 794 +++++++++++++
tests/xapian_tests/tests/test_interface.py | 205 ++++
tests/xapian_tests/tests/test_query.py | 445 ++++++++
xapian_backend.py | 1682 ++++++++++++++++++++++++++++
19 files changed, 3972 insertions(+)
diff --git a/.coveragerc b/.coveragerc
new file mode 100644
index 0000000..6965bba
--- /dev/null
+++ b/.coveragerc
@@ -0,0 +1,11 @@
+[report]
+exclude_lines =
+ def __repr__
+ raise NotImplementedError
+ raise MissingDependency
+ except xapian.DatabaseModifiedError
+
+[run]
+source =
+ haystack/backends/xapian_backend.py
+ test_haystack/xapian_tests
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..7633a6c
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,6 @@
+*.pyc
+*.tmproj
+*.DS_Store
+dist
+NOTES
+MANIFEST
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..7de3070
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,68 @@
+sudo: false
+language: python
+
+matrix:
+ include:
+ - python: 3.4
+ env: DJANGO_VERSION=1.10 XAPIAN_VERSION=1.4.1
+ - python: 3.4
+ env: DJANGO_VERSION=1.9 XAPIAN_VERSION=1.4.1
+ - python: 3.4
+ env: DJANGO_VERSION=1.8 XAPIAN_VERSION=1.4.1
+ - python: 3.4
+ env: DJANGO_VERSION=1.10 XAPIAN_VERSION=1.3.3
+ - python: 3.4
+ env: DJANGO_VERSION=1.9 XAPIAN_VERSION=1.3.3
+ - python: 3.4
+ env: DJANGO_VERSION=1.8 XAPIAN_VERSION=1.3.3
+ - python: 2.7
+ env: DJANGO_VERSION=1.10 XAPIAN_VERSION=1.4.1
+ - python: 2.7
+ env: DJANGO_VERSION=1.9 XAPIAN_VERSION=1.4.1
+ - python: 2.7
+ env: DJANGO_VERSION=1.8 XAPIAN_VERSION=1.4.1
+ - python: 2.7
+ env: DJANGO_VERSION=1.10 XAPIAN_VERSION=1.3.3
+ - python: 2.7
+ env: DJANGO_VERSION=1.9 XAPIAN_VERSION=1.3.3
+ - python: 2.7
+ env: DJANGO_VERSION=1.8 XAPIAN_VERSION=1.3.3
+ - python: 2.7
+ env: DJANGO_VERSION=1.10 XAPIAN_VERSION=1.2.24
+ - python: 2.7
+ env: DJANGO_VERSION=1.9 XAPIAN_VERSION=1.2.24
+ - python: 2.7
+ env: DJANGO_VERSION=1.8 XAPIAN_VERSION=1.2.24
+
+addons:
+ apt:
+ sources:
+ - ubuntu-toolchain-r-test
+ packages:
+ # Xapian requires uuid-dev, Xapian ==1.3.3 requires compilers with c++11.
+ - uuid-dev
+ - gcc-4.8
+ - g++-4.8
+
+install:
+ # install Xapian
+ - CXX=g++-4.8 ./install_xapian.sh $XAPIAN_VERSION
+
+ - pip install Django==$DJANGO_VERSION
+ - pip install coveralls
+
+ # install Django haystack
+ - cd .. # move from xapian-haystack
+ - git clone https://github.com/toastdriven/django-haystack.git
+
+ # cp xapian-haystack to django-haystack
+ - cp xapian-haystack/xapian_backend.py django-haystack/haystack/backends
+ - cp -r xapian-haystack/tests/* django-haystack/test_haystack/
+ - cp xapian-haystack/tests/xapian_tests/__init__.py django-haystack/test_haystack/
+ - cp xapian-haystack/.coveragerc django-haystack/
+
+script:
+ - cd django-haystack/
+ - PYTHONPATH=`pwd` coverage run `which django-admin.py` test test_haystack.xapian_tests --settings=test_haystack.xapian_settings
+
+after_success: coveralls
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..0dd3a99
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,31 @@
+Primary Authors:
+----------------
+
+ * David Sauve
+
+
+Thanks to:
+----------
+ * Daniel Lindsley for the awesome Haystack API and putting up with all of my questions.
+ * Trapeze Media <http://www.trapeze.com/> for providing time and resources to complete this project as well as Q&A.
+ * Richard Boulton for answering questions regarding the Xapian python bindings and API.
+ * The Xapian team for creating and releasing under the GPL, such a great search engine.
+ * Supreet Sethi for suggestions regarding morphologic date comparisons and for fixing NOT query expressions.
+ * Joshua Jonah for changes to highlighting logic to avoid reserved words.
+ * J00bar for a fix with `get_identifier`, fixing query_filter reference in SearchQuery, and a better clear method.
+ * Jannis Leidel for setting up the code base for pip, easy_install and PyPI.
+ * Erik Aigner for the initial patch to get_identifier changes.
+ * Travis Cline for the initial patch to support SQ objects in Haystack.
+ * wshallum for a patch that makes date facets compatible with Python 2.4
+ * askfor for reporting issues with narrow_queries and float fields.
+ * Brandon Konkle for a patch that corrected the behaviour of weights on multiple term boosts.
+ * Adam Endicott for the initial patch that corrected an oversight with stemming not always being done during a search.
+ * Sym Roe for a patch that improved performance in "more-like-this" and suggestion the removal of FLAG_PARTIAL.
+ * liranz for pointing out a potential conflict with arguments pass into `SearchResult`
+ * Jacob Kaplan-Moss for pointing out that write permission shouldn't be required for searching.
+ * glassresistor for assistance troubleshooting an issue with boosting a phrase query & a patch to make weighting schemes overridable.
+ * James Addison for helping to debug an intermittent issue with `order_by` and `build_schema`.
+ * Michael Opitz for a patch that enables support for `inmemorydb`.
+ * Evgeniy Kirov for a patch that adds `HAYSTACK_XAPIAN_LANGUAGE` used for setting the stemming language.
+ * domasx2 for a patch that explicitly closes the database when not in use.
+ * naktinis for a patch that fixed changes the behaviour of the `narrow_queries` argument of `search` so that queries are ANDed together rather than ORed.
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d8cf7d4
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,280 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..7c985df
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,3 @@
+include AUTHORS
+include LICENSE
+include README.rst
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..3e82fb5
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,139 @@
+Xapian backend for Django-Haystack
+==================================
+
+.. _Travis: https://travis-ci.org/notanumber/xapian-haystack
+
+.. image:: https://travis-ci.org/notanumber/xapian-haystack.svg?branch=master
+ :target: https://travis-ci.org/notanumber/xapian-haystack
+.. image:: https://coveralls.io/repos/notanumber/xapian-haystack/badge.svg?branch=master&service=github
+ :target: https://coveralls.io/github/notanumber/xapian-haystack?branch=master
+
+Xapian-haystack is a backend of `Django-Haystack <http://haystacksearch.org/>`__
+for the `Xapian <http://xapian.org>`__ search engine.
+Thanks for checking it out.
+
+You can find more information about Xapian `here <http://getting-started-with-xapian.readthedocs.org>`__.
+
+
+Features
+--------
+
+Xapian-Haystack provides all the standard features of Haystack:
+
+- Weighting
+- Faceted search (date, query, etc.)
+- Sorting
+- Spelling suggestions
+- EdgeNGram and Ngram (for autocomplete)
+
+Limitations
+-----------
+
+The `endswith` search operation is not supported by Xapian-Haystack.
+
+
+Requirements
+------------
+
+- Python 2.7 or 3+
+- Django 1.8+
+- Django-Haystack 2.5.1
+- Xapian 1.2.19+
+
+In particular, we build-test this backend in `Travis`_ using:
+
+- Python 2.7 and 3.4
+- Django 1.8, 1.9 and 1.10
+- Django-Haystack (master)
+- Xapian 1.2.19 (Python 2 only), 1.3.3 (both), and 1.4.1 (both)
+
+
+Installation
+------------
+
+First, install Xapian in your machine e.g. with the script provided,
+`install_xapian.sh`. Call it after activating the virtual environment to install::
+
+ source <path>/bin/activate
+ ./install_xapian.sh <version>
+
+`<version>` must be >=1.3.0 for Python 3 envs. This takes around 10 minutes.
+
+Finally, install Xapian-Haystack by running::
+
+ pip install git+https://github.com/notanumber/xapian-haystack.git
+
+
+Configuration
+-------------
+
+Xapian is configured as other backends of Haystack.
+You have to define the connection to the database,
+which is done to a path to a directory, e.g::
+
+ HAYSTACK_CONNECTIONS = {
+ 'default': {
+ 'ENGINE': 'xapian_backend.XapianEngine',
+ 'PATH': os.path.join(os.path.dirname(__file__), 'xapian_index')
+ },
+ }
+
+The backend has the following optional settings:
+
+- ``HAYSTACK_XAPIAN_LANGUAGE``: the stemming language; the default is `english` and the list of available languages
+ can be found `here <http://xapian.org/docs/apidoc/html/classXapian_1_1Stem.html>`__.
+
+- ``HAYSTACK_XAPIAN_WEIGHTING_SCHEME``: a tuple with parameters to be passed to the weighting scheme
+ `BM25 <https://en.wikipedia.org/wiki/Okapi_BM25>`__.
+ By default, it uses the same parameters as Xapian recommends; this setting allows you to change them.
+
+- ``HAYSTACK_XAPIAN_FLAGS``: the options used to parse `AutoQueries`;
+ the default is ``FLAG_PHRASE | FLAG_BOOLEAN | FLAG_LOVEHATE | FLAG_WILDCARD | FLAG_PURE_NOT``
+ See `here <http://xapian.org/docs/apidoc/html/classXapian_1_1QueryParser.html>`__ for more information
+ on what they mean.
+
+- ``HAYSTACK_XAPIAN_STEMMING_STRATEGY``: This option lets you chose the stemming strategy used by Xapian. Possible
+ values are ``STEM_NONE``, ``STEM_SOME``, ``STEM_ALL``, ``STEM_ALL_Z``, where ``STEM_SOME`` is the default.
+ See `here <http://xapian.org/docs/apidoc/html/classXapian_1_1QueryParser.html#ac7dc3b55b6083bd3ff98fc8b2726c8fd>`__ for
+ more information about the different strategies.
+
+
+Testing
+-------
+
+Xapian-Haystack has a test suite in continuous deployment in `Travis`_. The script
+``.travis.yml`` contains the steps required to run the test suite.
+
+
+Source
+------
+
+The source code can be found in `github <http://github.com/notanumber/xapian-haystack/>`_.
+
+
+Credits
+-------
+
+Xapian-Haystack is maintained by `Jorge C. Leitão <http://jorgecarleitao.net>`__;
+`David Sauve <mailto:david.sauve at bag-of-holding.com>`__ was the main contributor of Xapian-Haystack and
+Xapian-Haystack was originally funded by `Trapeze <http://www.trapeze.com>`__.
+`Claudep <http://www.2xlibre.net>`__ is a frequent contributor.
+`ANtlord <https://github.com/ANtlord>`__ implemented support for EdgeNgram and Ngram.
+
+
+License
+-------
+
+Xapian-haystack is free software licenced under GNU General Public Licence v2 and
+Copyright (c) 2009, 2010, 2011, 2012 David Sauve, 2009, 2010 Trapeze, 2014 Jorge C. Leitão.
+It may be redistributed under the terms specified in the LICENSE file.
+
+
+Questions, Comments, Concerns:
+------------------------------
+
+Feel free to open an issue `here <http://github.com/notanumber/xapian-haystack/issues>`__
+or pull request your work.
+
+You can ask questions on the django-haystack `mailing list <http://groups.google.com/group/django-haystack/>`_:
+or in the irc ``#haystack``.
diff --git a/install_xapian.sh b/install_xapian.sh
new file mode 100755
index 0000000..0aee0cd
--- /dev/null
+++ b/install_xapian.sh
@@ -0,0 +1,54 @@
+#!/usr/bin/env bash
+# first argument of the script is Xapian version (e.g. 1.2.19)
+VERSION=$1
+
+# prepare
+mkdir $VIRTUAL_ENV/packages && cd $VIRTUAL_ENV/packages
+
+CORE=xapian-core-$VERSION
+BINDINGS=xapian-bindings-$VERSION
+
+# download
+echo "Downloading source..."
+curl -O https://oligarchy.co.uk/xapian/$VERSION/${CORE}.tar.xz
+curl -O https://oligarchy.co.uk/xapian/$VERSION/${BINDINGS}.tar.xz
+
+# extract
+echo "Extracting source..."
+tar xf ${CORE}.tar.xz
+tar xf ${BINDINGS}.tar.xz
+
+# install
+echo "Installing Xapian-core..."
+cd $VIRTUAL_ENV/packages/${CORE}
+./configure --prefix=$VIRTUAL_ENV && make && make install
+
+PYV=`python -c "import sys;t='{v[0]}'.format(v=list(sys.version_info[:1]));sys.stdout.write(t)";`
+
+if [ $PYV = "2" ]; then
+ PYTHON_FLAG=--with-python
+else
+ PYTHON_FLAG=--with-python3
+fi
+
+if [ $VERSION = "1.3.3" ]; then
+ XAPIAN_CONFIG=$VIRTUAL_ENV/bin/xapian-config-1.3
+else
+ XAPIAN_CONFIG=
+fi
+
+# The bindings for Python require python-sphinx
+echo "Installing Python-Sphinx..."
+pip install sphinx
+
+echo "Installing Xapian-bindings..."
+cd $VIRTUAL_ENV/packages/${BINDINGS}
+./configure --prefix=$VIRTUAL_ENV $PYTHON_FLAG XAPIAN_CONFIG=$XAPIAN_CONFIG && make && make install
+
+# clean
+cd $VIRTUAL_ENV
+rm -rf $VIRTUAL_ENV/packages
+
+# test
+echo "Testing Xapian..."
+python -c "import xapian"
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..f14b48e
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,2 @@
+Django>=1.8
+Django-Haystack>=2.5.1
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..517b445
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+import os
+from distutils.core import setup
+
+
+def read(fname):
+ return open(os.path.join(os.path.dirname(__file__), fname)).read()
+
+setup(
+ name='xapian-haystack',
+ version='2.1.0',
+ description='A Xapian backend for Haystack',
+ long_description=read('README.rst'),
+ classifiers=[
+ 'Development Status :: 5 - Production/Stable',
+ 'Intended Audience :: Developers',
+ 'License :: OSI Approved :: GNU General Public License (GPL)',
+ 'Topic :: Internet :: WWW/HTTP :: Indexing/Search',
+ 'Framework :: Django',
+ ],
+ author='Jorge C. Leitão',
+ author_email='jorgecarleitao at gmail.com',
+ url='http://github.com/notanumber/xapian-haystack',
+ download_url='http://github.com/notanumber/xapian-haystack/tarball/2.1.0',
+ license='GPL2',
+ py_modules=['xapian_backend'],
+ install_requires=[
+ 'django>=1.8',
+ 'django-haystack>=2.5.1',
+ ]
+)
diff --git a/tests/xapian_settings.py b/tests/xapian_settings.py
new file mode 100755
index 0000000..516106a
--- /dev/null
+++ b/tests/xapian_settings.py
@@ -0,0 +1,16 @@
+import os
+from .settings import *
+
+INSTALLED_APPS = [
+ 'django.contrib.contenttypes',
+ 'test_haystack.core',
+ 'test_haystack.xapian_tests',
+]
+
+HAYSTACK_CONNECTIONS = {
+ 'default': {
+ 'ENGINE': 'haystack.backends.xapian_backend.XapianEngine',
+ 'PATH': os.path.join('tmp', 'test_xapian_query'),
+ 'INCLUDE_SPELLING': True,
+ }
+}
diff --git a/tests/xapian_tests/__init__.py b/tests/xapian_tests/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/tests/xapian_tests/models.py b/tests/xapian_tests/models.py
new file mode 100644
index 0000000..496c6b4
--- /dev/null
+++ b/tests/xapian_tests/models.py
@@ -0,0 +1,41 @@
+from django.db import models
+from django.contrib.contenttypes.models import ContentType
+
+from ..core.models import MockTag, AnotherMockModel, MockModel, AFourthMockModel
+
+
+class Document(models.Model):
+ type_name = models.CharField(max_length=50)
+ number = models.IntegerField()
+ name = models.CharField(max_length=200)
+
+ date = models.DateField()
+
+ summary = models.TextField()
+ text = models.TextField()
+
+
+class BlogEntry(models.Model):
+ """
+ Same as tests.core.MockModel with a few extra fields for testing various
+ sorting and ordering criteria.
+ """
+ datetime = models.DateTimeField()
+ date = models.DateField()
+
+ tags = models.ManyToManyField(MockTag)
+
+ author = models.CharField(max_length=255)
+ text = models.TextField()
+ funny_text = models.TextField()
+ non_ascii = models.TextField()
+ url = models.URLField()
+
+ boolean = models.BooleanField()
+ number = models.IntegerField()
+ float_number = models.FloatField()
+ decimal_number = models.DecimalField(max_digits=4, decimal_places=2)
+
+
+class DjangoContentType(models.Model):
+ content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
diff --git a/tests/xapian_tests/search_indexes.py b/tests/xapian_tests/search_indexes.py
new file mode 100644
index 0000000..a588290
--- /dev/null
+++ b/tests/xapian_tests/search_indexes.py
@@ -0,0 +1,162 @@
+from __future__ import unicode_literals
+
+from haystack import indexes
+
+from . import models
+
+
+class DocumentIndex(indexes.SearchIndex, indexes.Indexable):
+ text = indexes.CharField(document=True)
+ summary = indexes.CharField(model_attr='summary')
+
+ type_name = indexes.CharField(model_attr='type_name')
+
+ number = indexes.IntegerField(model_attr='number')
+
+ name = indexes.CharField(model_attr='name')
+ date = indexes.DateField(model_attr='date')
+
+ tags = indexes.MultiValueField()
+
+ def get_model(self):
+ return models.Document
+
+ def prepare_tags(self, obj):
+ l = [['tag', 'tag-test', 'tag-test-test'],
+ ['tag', 'tag-test'],
+ ['tag']]
+ return l[obj.id % 3]
+
+
+class BlogSearchIndex(indexes.SearchIndex):
+ text = indexes.CharField(
+ document=True, use_template=True,
+ template_name='search/indexes/core/mockmodel_text.txt'
+ )
+ name = indexes.CharField(model_attr='author', faceted=True)
+ date = indexes.DateField(model_attr='date')
+ datetime = indexes.DateField(model_attr='datetime')
+ number = indexes.IntegerField(model_attr='number')
+ boolean = indexes.BooleanField(model_attr='boolean')
+ #slug = indexes.CharField(indexed=False, model_attr='slug')
+ float_number = indexes.FloatField(model_attr='float_number')
+ month = indexes.CharField(indexed=False)
+ url = indexes.CharField(model_attr='url')
+ empty = indexes.CharField()
+
+ # Various MultiValueFields
+ sites = indexes.MultiValueField()
+ tags = indexes.MultiValueField()
+ keys = indexes.MultiValueField()
+ titles = indexes.MultiValueField()
+
+ def get_model(self):
+ return models.BlogEntry
+
+ def prepare_sites(self, obj):
+ return ['%d' % (i * obj.id) for i in range(1, 4)]
+
+ def prepare_tags(self, obj):
+ if obj.id == 1:
+ return ['a', 'b', 'c']
+ elif obj.id == 2:
+ return ['ab', 'bc', 'cd']
+ else:
+ return ['an', 'to', 'or']
+
+ def prepare_keys(self, obj):
+ return [i * obj.id for i in range(1, 4)]
+
+ def prepare_titles(self, obj):
+ if obj.id == 1:
+ return ['object one title one', 'object one title two']
+ elif obj.id == 2:
+ return ['object two title one', 'object two title two']
+ else:
+ return ['object three title one', 'object three title two']
+
+ def prepare_month(self, obj):
+ return '%02d' % obj.date.month
+
+ def prepare_empty(self, obj):
+ return ''
+
+
+class CompleteBlogEntryIndex(indexes.SearchIndex):
+ text = indexes.CharField(model_attr='text', document=True)
+ author = indexes.CharField(model_attr='author')
+ url = indexes.CharField(model_attr='url')
+ non_ascii = indexes.CharField(model_attr='non_ascii')
+ funny_text = indexes.CharField(model_attr='funny_text')
+
+ datetime = indexes.DateTimeField(model_attr='datetime')
+ date = indexes.DateField(model_attr='date')
+
+ boolean = indexes.BooleanField(model_attr='boolean')
+ number = indexes.IntegerField(model_attr='number')
+ float_number = indexes.FloatField(model_attr='float_number')
+ decimal_number = indexes.DecimalField(model_attr='decimal_number')
+
+ multi_value = indexes.MultiValueField()
+
+ def get_model(self):
+ return models.BlogEntry
+
+ def prepare_multi_value(self, obj):
+ return [tag.name for tag in obj.tags.all()]
+
+
+class XapianNGramIndex(indexes.SearchIndex):
+ text = indexes.CharField(model_attr='author', document=True)
+ ngram = indexes.NgramField(model_attr='author')
+
+ def get_model(self):
+ return models.BlogEntry
+
+
+class XapianEdgeNGramIndex(indexes.SearchIndex):
+ text = indexes.CharField(model_attr='author', document=True)
+ edge_ngram = indexes.EdgeNgramField(model_attr='author')
+
+ def get_model(self):
+ return models.BlogEntry
+
+
+class DjangoContentTypeIndex(indexes.SearchIndex):
+ text = indexes.CharField(document=True)
+
+ def get_model(self):
+ return models.DjangoContentType
+
+
+class MockSearchIndex(indexes.SearchIndex):
+ text = indexes.CharField(document=True, use_template=True)
+ name = indexes.CharField(model_attr='author', faceted=True)
+ pub_date = indexes.DateTimeField(model_attr='pub_date')
+ title = indexes.CharField()
+
+ def get_model(self):
+ return models.MockModel
+
+
+class BoostMockSearchIndex(indexes.SearchIndex):
+ text = indexes.CharField(
+ document=True, use_template=True,
+ template_name='search/indexes/core/mockmodel_template.txt'
+ )
+ author = indexes.CharField(model_attr='author', weight=2.0)
+ editor = indexes.CharField(model_attr='editor')
+ pub_date = indexes.DateField(model_attr='pub_date')
+
+ def get_model(self):
+ return models.AFourthMockModel
+
+
+class MockQueryIndex(indexes.SearchIndex):
+ text = indexes.CharField(document=True)
+ pub_date = indexes.DateTimeField()
+ title = indexes.CharField()
+ foo = indexes.CharField()
+
+ def get_model(self):
+ return models.MockModel
diff --git a/tests/xapian_tests/tests/__init__.py b/tests/xapian_tests/tests/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/tests/xapian_tests/tests/test_backend.py b/tests/xapian_tests/tests/test_backend.py
new file mode 100644
index 0000000..1f8f353
--- /dev/null
+++ b/tests/xapian_tests/tests/test_backend.py
@@ -0,0 +1,794 @@
+from __future__ import unicode_literals
+
+from decimal import Decimal
+import datetime
+import sys
+import xapian
+import subprocess
+import os
+
+from django.apps import apps
+from django.contrib.contenttypes.models import ContentType
+from django.test import TestCase
+from django.utils.encoding import force_text
+
+from haystack import connections
+from haystack.backends.xapian_backend import InvalidIndexError, _term_to_xapian_value
+from haystack.models import SearchResult
+from haystack.utils.loading import UnifiedIndex
+
+from ..search_indexes import XapianNGramIndex, XapianEdgeNGramIndex, \
+ CompleteBlogEntryIndex, BlogSearchIndex, DjangoContentTypeIndex
+from ..models import BlogEntry, AnotherMockModel, MockTag, DjangoContentType
+
+
+XAPIAN_VERSION = [int(x) for x in xapian.__version__.split('.')]
+
+
+class XapianSearchResult(SearchResult):
+ def __init__(self, app_label, model_name, pk, score, **kwargs):
+ super(XapianSearchResult, self).__init__(app_label, model_name, pk, score, **kwargs)
+ self._model = apps.get_model('xapian_tests', model_name)
+
+
+def get_terms(backend, *args):
+ if XAPIAN_VERSION[1] <= 2:
+ # old versions use "delve".
+ executable = 'delve'
... 3107 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-xapian-haystack.git
More information about the Python-modules-commits
mailing list