Skip to content

Commit 12bed1c

Browse files
committed
[ENH] Logo, setup.py and README updated
1 parent 58934ce commit 12bed1c

File tree

4 files changed

+11
-6
lines changed

4 files changed

+11
-6
lines changed

README.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
![Petrovich](petrovich.png) pytrovich
1+
![Pytrovich](pytrovich.png)
22
==========================================
33

4-
__pytrovich__ is a library which inflects Russian names to given grammatical case. It supports first names, last names and middle names inflections.
4+
__pytrovich__ is a Python 3.6+ port of [petrovich library](https://github.com/petrovich) which inflects Russian names
5+
to a given grammatical case. It supports first names, last names and middle names inflections.
56

6-
__pytrovich__ is a Python implementation of Petrovich ruby gem
7-
([petrovich-java](https://github.com/petrovich/petrovich-java) being the main inspiration)
7+
[petrovich-java](https://github.com/petrovich/petrovich-java) was the main inspiration.
88

99
## Usage
1010

@@ -27,7 +27,12 @@ maker = PetrovichDeclinationMaker("/path/to/custom/rules.file.json")
2727

2828
### More info
2929

30-
For more info please refer to [petrovich](https://github.com/petrovich/) repos.
30+
For more info please refer to other [petrovich](https://github.com/petrovich/) repos.
31+
32+
### TODO
33+
34+
- grammatical gender detection (given the name)
35+
- `How to cite us` section
3136

3237
### License
3338

petrovich.png

-1.72 KB
Binary file not shown.

pytrovich.png

7.49 KB
Loading

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
name="pytrovich",
99
packages=setuptools.find_packages(),
1010
version="0.0.1",
11-
description="petrovich: an inflector for Russian anthroponyms, Python port",
11+
description="pytrovich: a Python port of an inflector for Russian anthroponyms developed by petrovich team: https://github.com/petrovich",
1212
long_description=long_description,
1313
long_description_content_type="text/markdown",
1414
author="Anton Alekseev",

0 commit comments

Comments
 (0)