/Hypy

Primary LanguageC

Hypy Build Status

Hypy is a fulltext search interface for Python applications. Use it to index and search your documents from Python code.

Hypy is based on the estraiernative bindings by Yusuke Yoshida.

The estraiernative bindings are, in turn, based on Hyper Estraier by Mikio Hirabayashi.

README

Installation: Non-Ubuntu

You will need to (a) install Hyper Estraier, then (b) install Hypy.

Installing Hyper Estraier from Source

Instructions for building and installing Hyper Estraier can be found on that site. It is a standard configure/make/make install process, but you must make sure to download all the required files. See the Hyper Estraier installation page for details.

Then: Install Hypy with pip

pip install hypy

Running tests

tox

Build/upload

  • Update setup.py with a new version
  • Update the Change Log below
  • Commit your changes to the above files.
  • Add and push a tag for the new release
$ python setup.py sdist bdist_wheel && python3 setup.py bdist_wheel
$ twine upload dist/*

For point releases: Make sure there is a series-0.x branch in github, and branch from that branch.

Quick Start

You can get an instant "oh I get it!" fix by looking inside the "examples" directory distributed with this software.

Index documents into a collection (see gather.py for the complete program):

...
db = HDatabase()
db.open('casket', 'w')
# create a document object
doc = HDocument(uri=u'http://estraier.gov/example.txt')
...

Search for documents in an existing collection (see search.py for the complete program):

...
# create a search condition object
cond = HCondition(u'lull*')
# get the result of search
result = db.search(cond)
# iterate the result
for doc in result:
...

Hey, I need Even More Examples

OK.

Here are even more examples.

Read This! - Unicode

Hypy requires Unicode objects in all of its APIs.

WRONG

>>> d = HDocument(uri='http://pinatas.com/store.html') # byte string!
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/usr/lib/python2.5/site-pacakges/hypy/lib.py", line 291, in __init__
    raise TypeError("Must provide uri as unicode text")
TypeError: Must provide uri as unicode text

RIGHT

>>> d = HDocument(uri=u'http://pinatas.com/store.html') # unicode :-)
>>> d.addText(u'Olé')
>>> d[u'@title'] = u'Piñata Store'  # attributes are also unicode

Because of this change, and some other minor, Python-enhancing differences between the APIs, I have deliberately renamed all the classes and methods supported by Hypy, to prevent confusion. If you know Python and are already familiar with Hyper Estraier, you should now visit the API docs to learn the new names of functions. In general, though, "est_someclass_foo_bar" takes a byte string in Hyper Estraier, but becomes "HSomeClass.fooBar" in Hypy and takes Unicode text.

What's not Supported in Hypy vs. Hyper Estraier

Hyper Estraier implements a version of federated search which is supported by its APIs such as merge, search_meta and eclipse. If I hear a compelling use case or receive patches with unit tests, I may add support for these APIs. This is not a hard thing to do, I just have no use for it myself, so I am reluctant to promise to maintain it unless someone else really needs it.

License

LGPL 2.1

Hypy (c) Cory Dodt, 2018.

estraiernative (c) Yusuke Yoshida.

Change Log

1.0.1 - 2019-12-13

Added:

  • (#5) Python 3 support!

    Automatic builds will test with Python 3.7 for now.

0.8.8 - 2019-08-07

Fixed:

  • (#1) move pytest into dev requirements and drop the required version

0.8.7 - 2018-03-21

Changed:

  • Modernize packaging and add travis builds

0.8.5.1 - 2014-07-27

Fixed:

  • version issue with pypi

0.8.5 - 2014-07-22

Changed:

  • Hypy indexes are now iterable

0.8.4 - 2009.09.19

Changed:

  • It is now possible to construct an attribute-only search with None for search phrase.

0.8.3 - 2009.02.22

Changed:

  • Massively improved docstrings and internal documentation. An extensive examples document is now available

Fixed:

  • Filter out null bytes while indexing.

  • Improve performance of attribute searches.

  • Add a teaser rst format i.e. foo

0.8.2 - 2009-01-20

Fixed:

  • I was unconditionally importing ez_setup in my setup.py and that makes it hard to easy_install. Don't do that.

  • No library functionality change, but now more users can install it.

0.8.1 - 2008-12-15

Added:

  • Initial Public Opensourcing.