From ea2d9fec829f4f609b9394009e4ef388484da06e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jorge=20C=2E=20Leit=C3=A3o?= Date: Mon, 16 Nov 2015 15:47:56 +0100 Subject: [PATCH] Updated setup.py and README. --- README.rst | 26 +++++++++++++------------- setup.py | 17 +++++++++++++---- 2 files changed, 26 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index 880d88b..883b03d 100644 --- a/README.rst +++ b/README.rst @@ -8,11 +8,11 @@ Xapian backend for Django-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 `_ -for the `Xapian `_ search engine. +Xapian-haystack is a backend of `Django-Haystack `__ +for the `Xapian `__ search engine. Thanks for checking it out. -You can find more information about Xapian `here `_. +You can find more information about Xapian `here `__. Features @@ -76,20 +76,20 @@ which is done to a path to a directory, e.g:: 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 `_. + can be found `here `__. - ``HAYSTACK_XAPIAN_WEIGHTING_SCHEME``: a tuple with parameters to be passed to the weighting scheme - `BM25 `_. + `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 `_ for more information + See `here `__ 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 `_ for + See `here `__ for more information about the different strategies. @@ -109,10 +109,10 @@ The source code can be found in `github `_ was the main contributor of Xapian-Haystack and -Xapian-Haystack was originally funded by `Trapeze `_. -`ANtlord `_ implemented support for EdgeNgram and Ngram. +Xapian-Haystack is maintained by `Jorge C. Leitão `__; +`David Sauve `__ was the main contributor of Xapian-Haystack and +Xapian-Haystack was originally funded by `Trapeze `__. +`ANtlord `__ implemented support for EdgeNgram and Ngram. License @@ -126,8 +126,8 @@ It may be redistributed under the terms specified in the LICENSE file. Questions, Comments, Concerns: ------------------------------ -Feel free to open an issue `here `_ +Feel free to open an issue `here `__ or pull request your work. -You can ask questions on the django-haystack `mailing list `_ +You can ask questions on the django-haystack `mailing list `_: or in the irc ``#haystack``. diff --git a/setup.py b/setup.py index 533d902..3b07a84 100644 --- a/setup.py +++ b/setup.py @@ -1,24 +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.0.0', - description="A Xapian backend for Haystack", + description='A Xapian backend for Haystack', long_description=read('README.rst'), classifiers=[ - 'Development Status :: 4 - Beta', + '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='David Sauve', - author_email='david.sauve@bag-of-holding.com', + author='Jorge C. Leitão', + author_email='jorgecarleitao@gmail.com', url='http://github.com/notanumber/xapian-haystack', + download_url='http://github.com/notanumber/xapian-haystack/tarball/2.0.0', license='GPL2', py_modules=['xapian_backend'], + install_requires=[ + 'django>=1.6', + 'django-haystack>=2', + ] )