Skip to content

JoshBradshaw/python-nameparser

 
 

Repository files navigation

Name Parser

A simple Python module for parsing human names into their individual components. The HumanName class splits a name string up into name parts based on placement in the string and matches against known name pieces like titles. It joins name pieces on conjunctions and special prefixes to last names like "del". Titles can be chained together and include conjunctions to handle titles like "Asst Secretary of State". It can also try to correct capitalization.

It attempts the best guess that can be made with a simple, rule-based approach. It's not perfect, but it gets you pretty far.

Usage Example

>>> from nameparser import HumanName
>>> name = HumanName("Dr. Juan Q. Xavier de la Vega III (Doc Vega)")
>>> name
<HumanName : [
    title: 'Dr.'
    first: 'Juan'
    middle: 'Q. Xavier'
    last: 'de la Vega'
    suffix: 'III'
    nickname: 'Doc Vega'
]>

Unit Tests

Over 100 unit tests with example names. Start a New Issue for names that fail and I will try to fix it.

Installation

If you're starting a new project, I recommend installing master from GitHub to give v0.3 a try. Customizing it is not backwards compatible with v0.2.10 (the current version on pypi) because the configuration layout changed, but passes all the same tests, and is easier to configure.

pip install -e git+git://github.com/derek73/python-nameparser.git#egg=nameparser

If you're looking for a web service, check out eyeseast's nameparse service, a simple Heroku-friendly Flask wrapper for this module.

Documentation

NOTE: This documentation covers the new version 0.3 that has yet to be released to PyPi. For the v0.2.10 documentation, see the v0.2.10 tag on GitHub.

http://nameparser.readthedocs.org/en/latest/

Contributing

If you come across name piece that you think should be in the default config, you're probably right. Start a New Issue and we can get them added.

Or, use GitHub's nifty web interface to add your new pieces directly to the config files and create a pull request all in one go, no fork needed. As an example, click here to propose changes to the titles config.

Please let me know if there are ways this library could be restructured to make it easier for you to use in your projects. Read CONTRIBUTING.md for more info on running the tests and contributing to the project.

GitHub Project

https://github.com/derek73/python-nameparser

About

A simple Python module for parsing human names into their individual components

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors