bountyhunter 0.1.6

  • readme.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 62

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

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or flutter packages 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';
  
Version Uploaded Documentation Archive
0.1.6 Jun 23, 2018 Go to the documentation of bountyhunter 0.1.6 Download bountyhunter 0.1.6 archive
0.1.5+1 Nov 8, 2014 Go to the documentation of bountyhunter 0.1.5+1 Download bountyhunter 0.1.5+1 archive
0.1.5 Nov 6, 2014 Go to the documentation of bountyhunter 0.1.5 Download bountyhunter 0.1.5 archive
0.1.4+1 Nov 6, 2014 Go to the documentation of bountyhunter 0.1.4+1 Download bountyhunter 0.1.4+1 archive
0.1.4 Sep 1, 2014 Go to the documentation of bountyhunter 0.1.4 Download bountyhunter 0.1.4 archive
0.1.3+1 Aug 26, 2014 Go to the documentation of bountyhunter 0.1.3+1 Download bountyhunter 0.1.3+1 archive
0.1.3 Aug 26, 2014 Go to the documentation of bountyhunter 0.1.3 Download bountyhunter 0.1.3 archive
0.1.2+1 Aug 25, 2014 Go to the documentation of bountyhunter 0.1.2+1 Download bountyhunter 0.1.2+1 archive
0.1.2 Aug 25, 2014 Go to the documentation of bountyhunter 0.1.2 Download bountyhunter 0.1.2 archive
0.1.1 Aug 25, 2014 Go to the documentation of bountyhunter 0.1.1 Download bountyhunter 0.1.1 archive

All 14 versions...

Analysis

We analyzed this package on Jul 13, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.63.0
  • pana: 0.11.3

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
27 / 100
Health:
Code health derived from static analysis. [more]
96 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
99 / 100
Overall score:
Weighted score of the above. [more]
62
Learn more about scoring.

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:bountyhunter/bountyhunter.dart.

Suggestions

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 1 error 11 hints.

    Strong-mode analysis of lib/src/bounty.dart failed with the following error:

    line: 11 col: 3
    Invalid override. The type of 'Bounty.compareTo' ('(Bounty) → int') isn't a subtype of 'Comparable<dynamic>.compareTo' ('(dynamic) → int').

    Run dartfmt to format lib/bountyhunter.dart.

    Similar analysis of the following files failed:

    • lib/src/configuration.dart (hint)
    • lib/src/hunter.dart (hint)
    • lib/src/normalizer.dart (hint)
    • lib/src/stemming/porter_stemmer.dart (hint)
    • lib/src/stemming/stemmer.dart (hint)
    • lib/src/utils.dart (hint)
    • lib/src/vector.dart (hint)
  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Maintain an example.

    Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use bountyhunter.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
cargo >=0.8.0 <0.9.0 0.8.0
logging >=0.11.0 <0.12.0 0.11.3+1
Dev dependencies
unittest >=0.10.0 <0.10.1