nameparser 1.2.0__py3-none-any.whl

nameparser/util.py

@@ -0,0 +1,17 @@
+import logging
+from typing import Literal
+
+# http://code.google.com/p/python-nameparser/issues/detail?id=10
+log = logging.getLogger('HumanName')
+log.addHandler(logging.NullHandler())
+log.setLevel(logging.ERROR)
+
+
+HumanNameAttributeT = Literal['title', 'first', 'middle', 'last', 'suffix', 'nickname', 'surnames']
+
+
+def lc(value: str) -> str:
+    """Lower case and remove any periods to normalize for comparison."""
+    if not value:
+        return ''
+    return value.lower().strip('.')

nameparser-1.2.0.dist-info/METADATA

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: nameparser
+Version: 1.2.0
+Summary: A simple Python module for parsing human names into their individual components.
+Author-email: Derek Gulbranson <derek73@gmail.com>
+License: LGPL
+Keywords: names,parser
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Natural Language :: English
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Linguistic
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: typing_extensions>=4.5.0; python_version < "3.11"
+Dynamic: license-file
+
+Name Parser
+===========
+
+|Build Status| |PyPI| |PyPI version| |Documentation|
+
+A simple Python (3.10+) module for parsing human names into their
+individual components. 
+
+* hn.title
+* hn.first
+* hn.middle
+* hn.last
+* hn.suffix
+* hn.nickname
+* hn.surnames *(middle + last)*
+* hn.initials *(first initial of each name part)*
+
+Supported Name Structures
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The supported name structure is generally "Title First Middle Last Suffix", where all pieces 
+are optional. Comma-separated format like "Last, First" is also supported.
+
+1. Title Firstname "Nickname" Middle Middle Lastname Suffix
+2. Lastname [Suffix], Title Firstname (Nickname) Middle Middle[,] Suffix [, Suffix]
+3. Title Firstname M Lastname [Suffix], Suffix [Suffix] [, Suffix]
+
+Instantiating the `HumanName` class with a string splits on commas and then spaces, 
+classifying name parts based on placement in the string and matches against known name 
+pieces like titles and suffixes. 
+
+It correctly handles some common conjunctions and special prefixes to last names
+like "del". Titles and conjunctions can be chained together to handle complex
+titles like "Asst Secretary of State". It can also try to correct capitalization
+of names that are all upper- or lowercase names.
+
+It attempts the best guess that can be made with a simple, rule-based approach. 
+Its main use case is English and it is not likely to be useful for languages 
+that do not conform to the supported name structure. It's not perfect, but it 
+gets you pretty far.
+
+Installation
+------------
+
+::
+
+  pip install nameparser
+
+If you want to try out the latest code from GitHub you can
+install with pip using the command below.
+
+``pip install -e git+https://github.com/derek73/python-nameparser.git``
+
+If you need to handle lists of names, check out
+`namesparser <https://github.com/gwu-libraries/namesparser>`_, a
+compliment to this module that handles multiple names in a string.
+
+
+Quick Start 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'
+    ]>
+    >>> name.last
+    'de la Vega'
+    >>> name.as_dict()
+    {'last': 'de la Vega', 'suffix': 'III', 'title': 'Dr.', 'middle': 'Q. Xavier', 'nickname': 'Doc Vega', 'first': 'Juan'}
+    >>> str(name)
+    'Dr. Juan Q. Xavier de la Vega III (Doc Vega)'
+    >>> name.string_format = "{first} {last}"
+    >>> str(name)
+    'Juan de la Vega'
+
+
+The parser does not attempt to correct mistakes in the input. It mostly just splits on white
+space and puts things in buckets based on their position in the string. This also means
+the difference between 'title' and 'suffix' is positional, not semantic. "Dr" is a title
+when it comes before the name and a suffix when it comes after. ("Pre-nominal"
+and "post-nominal" would probably be better names.)
+
+::
+
+    >>> name = HumanName("1 & 2, 3 4 5, Mr.")
+    >>> name 
+    <HumanName : [
+    	title: '' 
+    	first: '3' 
+    	middle: '4 5' 
+    	last: '1 & 2' 
+    	suffix: 'Mr.'
+    	nickname: ''
+    ]>
+
+Customization
+-------------
+
+Your project may need some adjustment for your dataset. You can
+do this in your own pre- or post-processing, by `customizing the configured pre-defined 
+sets`_ of titles, prefixes, etc., or by subclassing the `HumanName` class. See the 
+`full documentation`_ for more information.
+
+
+`Full documentation`_
+~~~~~~~~~~~~~~~~~~~~~
+
+.. _customizing the configured pre-defined sets: http://nameparser.readthedocs.org/en/latest/customize.html
+.. _Full documentation: 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. 
+
+Please let me know if there are ways this library could be structured 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
+
+.. _CONTRIBUTING.md: https://github.com/derek73/python-nameparser/tree/master/CONTRIBUTING.md
+.. _Start a New Issue: https://github.com/derek73/python-nameparser/issues
+.. _click here to propose changes to the titles: https://github.com/derek73/python-nameparser/edit/master/nameparser/config/titles.py
+
+.. |Build Status| image:: https://github.com/derek73/python-nameparser/actions/workflows/python-package.yml/badge.svg
+   :target: https://github.com/derek73/python-nameparser/actions/workflows/python-package.yml
+.. |PyPI| image:: https://img.shields.io/pypi/v/nameparser.svg
+   :target: https://pypi.org/project/nameparser/
+.. |Documentation| image:: https://readthedocs.org/projects/nameparser/badge/?version=latest
+   :target: http://nameparser.readthedocs.io/en/latest/?badge=latest
+.. |PyPI version| image:: https://img.shields.io/pypi/pyversions/nameparser.svg
+   :target: https://pypi.org/project/nameparser/

nameparser-1.2.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+nameparser/__init__.py,sha256=u5lKOsn4fZ9ldPcx72s86XkDxTg6gF_KtlLDcm3eyfw,312
+nameparser/_version.py,sha256=mGi0_w34ITeMByNC6CbD7lrByXEilMGomtRGIAfkyY4,62
+nameparser/parser.py,sha256=37PjjrfoVowRjVNxeekX3sH3O42cRtFBhUO7J_0BFtU,38385
+nameparser/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nameparser/util.py,sha256=99v8cudNuunZq30H4zBQwAmZraHf2NzGJy1ueVTqa10,487
+nameparser/config/__init__.py,sha256=OrVQo7jpjwvocDsaZYJiGNDKWwDM8kHgPbz5Yso7uJU,9812
+nameparser/config/capitalization.py,sha256=W0xv4zqK2WkqOyqoNZ6xvW4nb7t1NZtJuSZq-SOxCtE,208
+nameparser/config/conjunctions.py,sha256=D0DXBP0fDax2znPdAaB0880t83kUKpKYi-blMFcJWbM,300
+nameparser/config/prefixes.py,sha256=JUb9BDCGIl7jl119u9X4E8DhpiqftEdA6Uhd2ixdurg,1101
+nameparser/config/regexes.py,sha256=n9uuExgOqene-sfRfWwhqZGwWSQaUZFcCLrob_MQUTk,1080
+nameparser/config/suffixes.py,sha256=HHVdtXrZ_Kg9jOfJlzxVgiEgmwY8mJVzMERZpZbywMs,7835
+nameparser/config/titles.py,sha256=qaABn1ho8HVHJ3qRq58FwoZEfexKQ-nLvIqK7iagHZY,9741
+nameparser-1.2.0.dist-info/licenses/AUTHORS,sha256=W_1fAEdV7KOJh_psX1KZmJ7iLfDI_VKBIbKb9Eex21M,37
+nameparser-1.2.0.dist-info/licenses/LICENSE,sha256=EfTd-9HWXojdqvJ56lmKf9Z3sJH-vPiPcYskM7PhFyU,637
+nameparser-1.2.0.dist-info/METADATA,sha256=ORyGg3ci7v2sd9X_40e9uCL90BrkB59bkai1Oc3mLBE,6290
+nameparser-1.2.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+nameparser-1.2.0.dist-info/top_level.txt,sha256=ymOIbs7a20R7EVL7_0LNZrwshcEmPbueeKYI4je38Oo,11
+nameparser-1.2.0.dist-info/RECORD,,

nameparser-1.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

nameparser-1.2.0.dist-info/licenses/AUTHORS

@@ -0,0 +1 @@
+Derek Gulbranson <derek73@gmail.com>

nameparser-1.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,16 @@
+Copyright Derek Gulbranson <derek73 at gmail>.
+http://derekgulbranson.com/
+
+-----
+
+LGPL-2.1+
+http://www.opensource.org/licenses/lgpl-license.html
+
+This library is free software; you can redistribute it and/or modify it under the
+terms of the GNU Lesser General Public License as published by the Free Software
+Foundation; either version 2.1 of the License, or (at your option) any later
+version.
+
+This library is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

nameparser-1.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+nameparser