Fist python client
_{Python client library for Fist full text search}

:floppy_disk: Install • :video_game: Quick start • :heart_eyes: Acknowledgements • :busts_in_silhouette: Contributing • :briefcase: License

:construction: Fist is a software in ALPHA stage and is heavily under development. So is this tiny wrapper.

This library attempts to provide a very simple wrapper around the Fist a fast full-text search and index server. This library has also only been tested under Python 3.

:floppy_disk: Install

    git clone https://github.com/puria/fistpy.git
    cd fistpy
    pip install -e .
    # waiting for: pip install fistpy 

:video_game: Quick start

from fist.client import Fist

f = Fist(host="localhost", port=5575)
f.index("document_1 Some text that I want to index")
f.index("document_2 Some other text that I want to index")
result = f.search("text")

print(len(result), result) # 2 ['document_1', 'document_2']

:heart_eyes: Acknowledgements

Copyright :copyright: 2019 by Dyne.org foundation, Amsterdam

Designed, written and maintained by Puria Nafisi Azizi.

Special thanks to the Fist authors and contributors.

:busts_in_silhouette: Contributing

1. :twisted_rightwards_arrows: FORK IT
2. Create your feature branch git checkout -b feature/branch
3. Commit your changes git commit -am 'Add some fooBar'
4. Push to the branch git push origin feature/branch
5. Create a new Pull Request
6. :pray: Thank you

:briefcase: License

Copyright 2019 Puria Nafisi Azizi <puria@dyne.org>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.