Skip to content

Commit 80b8e61

Browse files
committed
update docs and release log, add more badges
1 parent e9af444 commit 80b8e61

2 files changed

Lines changed: 18 additions & 5 deletions

File tree

README.rst

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
Name Parser
22
===========
33

4+
.. image:: https://travis-ci.org/derek73/python-nameparser.svg
5+
:target: https://travis-ci.org/derek73/python-nameparser
6+
.. image:: https://pypip.in/version/nameparser/badge.png
7+
:target: https://pypi.python.org/pypi/python-nameparser
8+
.. image:: https://pypip.in/download/nameparser/badge.png
9+
:target: https://pypi.python.org/pypi/python-nameparser
10+
.. image:: https://pypip.in/license/nameparser/badge.png
11+
:target: https://pypi.python.org/pypi/python-nameparser
12+
13+
414
A simple Python module for parsing human names into their individual
515
components. The HumanName class splits a name string up into name parts
616
based on placement in the string and matches against known name pieces
@@ -12,7 +22,7 @@ correct capitalization.
1222
It attempts the best guess that can be made with a simple, rule-based
1323
approach. It's not perfect, but it gets you pretty far.
1424

15-
**Usage Example**
25+
**Quick Start Example**
1626

1727
::
1828

@@ -36,9 +46,6 @@ approach. It's not perfect, but it gets you pretty far.
3646
Unit Tests
3747
------------
3848

39-
.. image:: https://travis-ci.org/derek73/python-nameparser.svg
40-
:target: https://travis-ci.org/derek73/python-nameparser
41-
4249
Over 100 unit tests with example names. `Start a New Issue`_
4350
for names that fail and I will try to fix it.
4451

docs/release_log.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
Release Log
22
===========
33

4-
* 0.3 - July 4, 2014
4+
* 0.3.2 - July 16, 2014
5+
- Retain original string in "original" attribute.
6+
- Collapse white space when using custom string format.
7+
- Fix #19, single comma name format may have trailing suffix
8+
* 0.3.1 - July 5, 2014
9+
- Fix Pypi package, include new config module.
10+
* 0.3.0 - July 4, 2014
511
- Refactor configuration to simplify modifications to constants (backwards incompatible)
612
- use unicode_literals to simplify Python 2 & 3 support.
713
- Generate documentation using sphinx and host on readthedocs.

0 commit comments

Comments
 (0)