Skip to content

Commit 1fd3e3e

Browse files
committed
Prepare for release issue #2
added minimum document updated packaging stuff
1 parent 6696ee8 commit 1fd3e3e

File tree

5 files changed

+43
-2
lines changed

5 files changed

+43
-2
lines changed

MANIFEST.in

+3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
include setup.py
22
include tox.ini
3+
include LICENSE
34
graft tests
45

6+
global-exclude __pycache__/*
7+

README.rst

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
sqlite-fts-python
2+
=================
3+
4+
sqlitefts-python provides binding for tokenizer of `SQLite Full-Text search(FTS3/4)`_.
5+
It allows you to write tokenizers in Python.
6+
7+
8+
SQLite has Full-Text search feature FTS3/FTS4 along with some `predefined tokenizers`_.
9+
It is easy to use and has enough functionality. Python has a built-in SQLite module,
10+
so that it is easy to use and deploy. You don't need anything else to full-text search.
11+
12+
But... Predefined tokenizers are not enough for some languages including Japanese. Also it is not easy to write own tokenizers.
13+
With this modules, you can write tokenizers in Python without any extra modules and C compiler.
14+
15+
16+
Requirements
17+
============
18+
19+
* FTS3/4 enabled SQLite
20+
21+
22+
Licence
23+
=======
24+
25+
This software is released under the MIT License, see LICENSE.
26+
27+
28+
Thanks
29+
======
30+
31+
* https://github.com/saaj
32+
33+
34+
.. _SQLite Full-Text search(FTS3/4): http://www.sqlite.org/fts3.html
35+
.. _predefined tokenizers: http://www.sqlite.org/fts3.html#tokenizer

README.txt

-1
This file was deleted.

setup.cfg

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[wheel]
2+
universal=1
3+

setup.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
name="sqlitefts",
66
version="0.2",
77
packages=["sqlitefts"],
8-
description='A Python binding of SQLite Full Text Search Tokenizer',
8+
description='A Python binding for tokenizers of SQLite Full Text Search',
9+
long_description=open('README.rst').read(),
910
url='https://github.com/hideaki-t/sqlite-fts-python/',
1011
classifiers=[
1112
'Development Status :: 2 - Pre-Alpha',

0 commit comments

Comments
 (0)