Skip to content

Commit da9ec2b

Browse files
committed
Initial import
1 parent 85c25ec commit da9ec2b

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@
1111
Documentation is built automatically and can be found on
1212
https://russiannames.readthedocs.org/en/latest/
1313

14+
## Installation
15+
16+
To install Python library use `pip install russiannames` via pip or `python setup.py install`
17+
18+
To use database you need MongoDB instance.
19+
Unpack db_data_bson.zip file from https://github.com/datacoon/russiannames/blob/master/data/bson/db_dump_bson.zip
20+
21+
and use `mongorestore` command to restore `names` database with 3 collections: names, surnames and midnames
22+
1423
## Features
1524

1625
Database of names used for identification

0 commit comments

Comments
 (0)