bountyhunter 0.1.6

Build Status

Bounty Hunter #

LOGO!

A full text search engine of unstructured documents. It is base upon a reversed index.

Simple usage #

First create an instance of cargo

Cargo storage = new Cargo(MODE: CargoMode.MEMORY);

Construct an instance of Hunter.

Hunter hunter = new Hunter( cargo );

Feed document into the system so it can be indexed.

hunter.feedDocSync( "hello world", "This is a hello world document ... fix");

You can also feed a document asynchronous and then it will use the asynchronous methods from Cargo.

hunter.feedDoc( "hello world", "This is a hello world document ... fix").then((int docId) {
	// do stuff here!
});

Search for a document and retrieve the documents containing these words.

hunter.search( "document fix" );

Example #

Client Hunter - code

Todo #

  • Possibility to add words that can be ignored, like stop words
  • Stemming for other languages

Contributing #

If you found a bug, just create a new issue or even better fork and issue a pull request with you fix.

Social media #

Twitter #

Follow us on twitter

Google+ #

Follow us on google+

or join our G+ Community

Changelog #

This file contains highlights of what changes on each version of the bountyhunter package.

Pub version 0.1.6 #

  • update logging package and cargo package to the latest version on pub

Pub version 0.1.5 & 0.1.5+1

  • provide async and sync methods for feedDoc on the hunter class.

Pub version 0.1.4+1 #

  • update cargo dependency

Pub version 0.1.4 #

  • introduce stemming, with the porter stemmer implemenation

Pub version 0.1.3+1 #

  • fix term normalization

Pub version 0.1.3 #

  • adding normalizers to the hunter

Pub version 0.1.2+1 #

  • improve scoring

Pub version 0.1.2 #

  • make bounty hunter jsonable

Pub version 0.1.1 #

  • refactor code to work on the client

Pub version 0.1.0 #

  • ranking algorithm to score the bounties the hunter is searching for

Pub version 0.0.3 #

  • fix refeeding, clean postings of the docId in the index

Pub version 0.0.2 #

  • adding stop word configuration
  • adding Bounty class to it

Pub version 0.0.1 #

  • initial setup of the project!

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  bountyhunter: ^0.1.6

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:bountyhunter/bountyhunter.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
--
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
--
Overall:
Weighted score of the above. [more]
0
Learn more about scoring.

The package version is not analyzed, because it does not support Dart 2. Until this is resolved, the package will receive a health and maintenance score of 0.

Analysis issues and suggestions

Support Dart 2 in pubspec.yaml.

The SDK constraint in pubspec.yaml doesn't allow the Dart 2.0.0 release. For information about upgrading it to be Dart 2 compatible, please see https://dart.dev/dart-2#migration.

Maintenance issues and suggestions

Make sure dartdoc successfully runs on your package's source files. (-10 points)

Dependencies were not resolved.