Code Monkey home page Code Monkey logo

fistpy's Introduction

Fist python client
Python client library for Fist full text search

Build Status Code coverage PyPI Dyne.org



๐Ÿšง 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.

๐Ÿšฉ Table of Contents (click to expand)

๐Ÿ’พ Install

pip install fistpy


๐ŸŽฎ 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']

f.delete("text")
result = f.search("text")

print(len(result), result) # 0 []

๐Ÿ˜ Acknowledgements

Copyright ยฉ๏ธ 2019 by Dyne.org foundation, Amsterdam

Designed, written and maintained by Puria Nafisi Azizi.

Special thanks to the Fist authors and contributors.


๐Ÿ‘ฅ Contributing

  1. ๐Ÿ”€ 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. ๐Ÿ™ Thank you

๐Ÿ’ผ License

Copyright 2019 Dyne.org foundation, Amsterdam

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.

fistpy's People

Contributors

puria avatar wanghenshui avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.