Skip to content

Commit 722cbc6

Browse files
committed
Add setup.py and pypi support
1 parent 3e7d1ec commit 722cbc6

File tree

3 files changed

+63
-0
lines changed

3 files changed

+63
-0
lines changed

MANIFEST.in

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
include LICENSE
2+
include README.md

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ BoGo
77
BoGo is a Python 3 Vietnamese input method conversion library. This library
88
is intentionally functional with no internal state and side-effect.
99

10+
Installation
11+
------------
12+
13+
```bash
14+
pip install bogo
15+
```
16+
1017
Usage
1118
-----
1219

setup.py

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
from distutils.core import setup
2+
3+
setup(
4+
name='bogo',
5+
packages=['bogo'],
6+
version='1.0.0',
7+
description='Python 3 library for implementing Vietnamese input method editors with a purely functional interface.',
8+
author='Trung Ngo',
9+
author_email='ndtrung4419@gmail.com',
10+
url='https://github.com/BoGoEngine/bogo-python',
11+
download_url='https://github.com/BoGoEngine/bogo-python/archive/v1.0.tar.gz',
12+
keywords=['vietnamese'],
13+
classifiers=[
14+
"Development Status :: 5 - Production/Stable",
15+
"Programming Language :: Python",
16+
"Programming Language :: Python :: 3",
17+
"License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
18+
"Operating System :: OS Independent",
19+
"Intended Audience :: Developers",
20+
"Topic :: Text Processing :: Linguistic",
21+
"Topic :: Software Development :: Libraries :: Python Modules"
22+
],
23+
long_description="""\
24+
BoGo is a Python 3 Vietnamese input method conversion library. This library
25+
is intentionally functional with no internal state and side-effect.
26+
27+
Usage
28+
-----
29+
30+
>>> import bogo
31+
>>> bogo.process_sequence('meof')
32+
'mèo'
33+
>>> bogo.process_sequence('meo2', rules=bogo.get_vni_definition())
34+
'mèo'
35+
>>> bogo.process_sequence('system')
36+
'system'
37+
>>> bogo.process_sequence('system', skip_non_vietnamese=False)
38+
'sýtem'
39+
40+
More help available with:
41+
42+
>>> help(bogo.bogo)
43+
44+
Some functions from bogo.bogo are exported to package toplevel:
45+
46+
- `process_key()`
47+
- `process_sequence()`
48+
- `get_telex_definition()`
49+
- `get_vni_definition()`
50+
51+
BoGo is extensively tested with Python 3.2 and Python 3.3.
52+
"""
53+
54+
)

0 commit comments

Comments
 (0)