METADATA 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. Metadata-Version: 2.0
  2. Name: Whoosh
  3. Version: 2.7.4
  4. Summary: Fast, pure-Python full text indexing, search, and spell checking library.
  5. Home-page: http://bitbucket.org/mchaput/whoosh
  6. Author: Matt Chaput
  7. Author-email: matt@whoosh.ca
  8. License: Two-clause BSD license
  9. Keywords: index search text spell
  10. Platform: UNKNOWN
  11. Classifier: Development Status :: 5 - Production/Stable
  12. Classifier: Intended Audience :: Developers
  13. Classifier: License :: OSI Approved :: BSD License
  14. Classifier: Natural Language :: English
  15. Classifier: Operating System :: OS Independent
  16. Classifier: Programming Language :: Python :: 2.5
  17. Classifier: Programming Language :: Python :: 3
  18. Classifier: Topic :: Software Development :: Libraries :: Python Modules
  19. Classifier: Topic :: Text Processing :: Indexing
  20. About Whoosh
  21. ============
  22. Whoosh is a fast, featureful full-text indexing and searching library
  23. implemented in pure Python. Programmers can use it to easily add search
  24. functionality to their applications and websites. Every part of how Whoosh
  25. works can be extended or replaced to meet your needs exactly.
  26. Some of Whoosh's features include:
  27. * Pythonic API.
  28. * Pure-Python. No compilation or binary packages needed, no mysterious crashes.
  29. * Fielded indexing and search.
  30. * Fast indexing and retrieval -- faster than any other pure-Python, scoring,
  31. full-text search solution I know of.
  32. * Pluggable scoring algorithm (including BM25F), text analysis, storage,
  33. posting format, etc.
  34. * Powerful query language.
  35. * Pure Python spell-checker (as far as I know, the only one).
  36. Whoosh might be useful in the following circumstances:
  37. * Anywhere a pure-Python solution is desirable to avoid having to build/compile
  38. native libraries (or force users to build/compile them).
  39. * As a research platform (at least for programmers that find Python easier to
  40. read and work with than Java ;)
  41. * When an easy-to-use Pythonic interface is more important to you than raw
  42. speed.
  43. Whoosh was created and is maintained by Matt Chaput. It was originally created
  44. for use in the online help system of Side Effects Software's 3D animation
  45. software Houdini. Side Effects Software Inc. graciously agreed to open-source
  46. the code.
  47. This software is licensed under the terms of the simplified BSD (A.K.A. "two
  48. clause" or "FreeBSD") license. See LICENSE.txt for information.
  49. Installing Whoosh
  50. =================
  51. If you have ``setuptools`` or ``pip`` installed, you can use ``easy_install``
  52. or ``pip`` to download and install Whoosh automatically::
  53. $ easy_install Whoosh
  54. or
  55. $ pip install Whoosh
  56. Learning more
  57. =============
  58. * Read the online documentation at https://whoosh.readthedocs.org/en/latest/
  59. * Join the Whoosh mailing list at http://groups.google.com/group/whoosh
  60. * File bug reports and view the Whoosh wiki at
  61. http://bitbucket.org/mchaput/whoosh/
  62. Getting the source
  63. ==================
  64. Download source releases from PyPI at http://pypi.python.org/pypi/Whoosh/
  65. You can check out the latest version of the source code using Mercurial::
  66. hg clone http://bitbucket.org/mchaput/whoosh