types-nameparser 0.3.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. types_nameparser-0.3.1/PKG-INFO +126 -0
  2. types_nameparser-0.3.1/README.md +102 -0
  3. types_nameparser-0.3.1/nameparser_stubs/__init__.pyi +101 -0
  4. types_nameparser-0.3.1/pyproject.toml +53 -0
  5. types_nameparser-0.3.1/setup.cfg +4 -0
  6. types_nameparser-0.3.1/types_nameparser.egg-info/PKG-INFO +126 -0
  7. types_nameparser-0.3.1/types_nameparser.egg-info/SOURCES.txt +7 -0
  8. types_nameparser-0.3.1/types_nameparser.egg-info/dependency_links.txt +1 -0
  9. types_nameparser-0.3.1/types_nameparser.egg-info/top_level.txt +1 -0
types_nameparser-0.3.1/PKG-INFO ADDED
@@ -0,0 +1,126 @@
1
+ Metadata-Version: 2.4
2
+ Name: types-nameparser
3
+ Version: 0.3.1
4
+ Summary: Typing stubs for the nameparser library
5
+ Author-email: Lucian Buzzo <lucian.buzzo@gmail.com>
6
+ Maintainer-email: Lucian Buzzo <lucian.buzzo@gmail.com>
7
+ License: MIT
8
+ Keywords: typing,stubs,nameparser,type-hints
9
+ Classifier: Development Status :: 4 - Beta
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: License :: OSI Approved :: MIT License
12
+ Classifier: Operating System :: OS Independent
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.8
15
+ Classifier: Programming Language :: Python :: 3.9
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
20
+ Classifier: Topic :: Software Development :: Quality Assurance
21
+ Classifier: Typing :: Stubs Only
22
+ Requires-Python: >=3.8
23
+ Description-Content-Type: text/markdown
24
+
25
+ # types-nameparser
26
+
27
+ [![PyPI version](https://badge.fury.io/py/types-nameparser.svg)](https://badge.fury.io/py/types-nameparser)
28
+ [![Python versions](https://img.shields.io/pypi/pyversions/types-nameparser.svg)](https://pypi.org/project/types-nameparser/)
29
+
30
+ Typing stubs for the [nameparser](https://github.com/derek73/python-nameparser) library.
31
+
32
+ ## Overview
33
+
34
+ This package provides type information (stub files) for the `nameparser` library, enabling better IDE support and static type checking when working with human name parsing functionality.
35
+
36
+ The `nameparser` library is a Python library for parsing human names into their component parts (first name, last name, middle name, title, suffix, etc.), but it doesn't include type hints. This package fills that gap by providing comprehensive type stubs.
37
+
38
+ ## Installation
39
+
40
+ ```bash
41
+ pip install types-nameparser
42
+ ```
43
+
44
+ Or if you're using [uv](https://github.com/astral-sh/uv):
45
+
46
+ ```bash
47
+ uv add types-nameparser
48
+ ```
49
+
50
+ ## Usage
51
+
52
+ After installation, you can use the type stubs with your existing `nameparser` code:
53
+
54
+ ```python
55
+ from nameparser import HumanName
56
+
57
+ # Now you get full type hints and IDE support!
58
+ name = HumanName("Dr. John Michael Smith Jr.")
59
+ print(name.first) # "John"
60
+ print(name.last) # "Smith"
61
+ print(name.middle) # "Michael"
62
+ print(name.title) # "Dr."
63
+ print(name.suffix) # "Jr."
64
+ ```
65
+
66
+ ## Type Information
67
+
68
+ The stubs provide type information for the `HumanName` class with the following properties:
69
+
70
+ - `first: str` - First name component
71
+ - `last: str` - Last name component
72
+ - `middle: str` - Middle name component
73
+ - `title: str` - Title component (Mr., Mrs., Dr., etc.)
74
+ - `suffix: str` - Suffix component (Jr., Sr., III, etc.)
75
+ - `nickname: str` - Nickname component
76
+
77
+ ## Development
78
+
79
+ This project uses [uv](https://github.com/astral-sh/uv) for dependency management and [just](https://github.com/casey/just) for task running.
80
+
81
+ ### Setup
82
+
83
+ ```bash
84
+ # Install dependencies
85
+ just install
86
+ ```
87
+
88
+ ### Available Commands
89
+
90
+ ```bash
91
+ # Run linting
92
+ just lint
93
+
94
+ # Run linting with auto-fix
95
+ just lint-fix
96
+
97
+ # Format code
98
+ just format
99
+
100
+ # Type checking
101
+ just type-check
102
+
103
+ # Run tests
104
+ just test
105
+
106
+ # Run tests with coverage
107
+ just test-cov
108
+ ```
109
+
110
+ ## Requirements
111
+
112
+ - Python 3.10+
113
+ - The actual `nameparser` library (this package only provides type stubs)
114
+
115
+ ## License
116
+
117
+ This project is licensed under the same terms as the original `nameparser` library.
118
+
119
+ ## Contributing
120
+
121
+ Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
122
+
123
+ ## Related Projects
124
+
125
+ - [nameparser](https://github.com/derek73/python-nameparser) - The original name parsing library
126
+ - [typeshed](https://github.com/python/typeshed) - Collection of type stubs for Python standard library and third-party packages
types_nameparser-0.3.1/README.md ADDED
@@ -0,0 +1,102 @@
1
+ # types-nameparser
2
+
3
+ [![PyPI version](https://badge.fury.io/py/types-nameparser.svg)](https://badge.fury.io/py/types-nameparser)
4
+ [![Python versions](https://img.shields.io/pypi/pyversions/types-nameparser.svg)](https://pypi.org/project/types-nameparser/)
5
+
6
+ Typing stubs for the [nameparser](https://github.com/derek73/python-nameparser) library.
7
+
8
+ ## Overview
9
+
10
+ This package provides type information (stub files) for the `nameparser` library, enabling better IDE support and static type checking when working with human name parsing functionality.
11
+
12
+ The `nameparser` library is a Python library for parsing human names into their component parts (first name, last name, middle name, title, suffix, etc.), but it doesn't include type hints. This package fills that gap by providing comprehensive type stubs.
13
+
14
+ ## Installation
15
+
16
+ ```bash
17
+ pip install types-nameparser
18
+ ```
19
+
20
+ Or if you're using [uv](https://github.com/astral-sh/uv):
21
+
22
+ ```bash
23
+ uv add types-nameparser
24
+ ```
25
+
26
+ ## Usage
27
+
28
+ After installation, you can use the type stubs with your existing `nameparser` code:
29
+
30
+ ```python
31
+ from nameparser import HumanName
32
+
33
+ # Now you get full type hints and IDE support!
34
+ name = HumanName("Dr. John Michael Smith Jr.")
35
+ print(name.first) # "John"
36
+ print(name.last) # "Smith"
37
+ print(name.middle) # "Michael"
38
+ print(name.title) # "Dr."
39
+ print(name.suffix) # "Jr."
40
+ ```
41
+
42
+ ## Type Information
43
+
44
+ The stubs provide type information for the `HumanName` class with the following properties:
45
+
46
+ - `first: str` - First name component
47
+ - `last: str` - Last name component
48
+ - `middle: str` - Middle name component
49
+ - `title: str` - Title component (Mr., Mrs., Dr., etc.)
50
+ - `suffix: str` - Suffix component (Jr., Sr., III, etc.)
51
+ - `nickname: str` - Nickname component
52
+
53
+ ## Development
54
+
55
+ This project uses [uv](https://github.com/astral-sh/uv) for dependency management and [just](https://github.com/casey/just) for task running.
56
+
57
+ ### Setup
58
+
59
+ ```bash
60
+ # Install dependencies
61
+ just install
62
+ ```
63
+
64
+ ### Available Commands
65
+
66
+ ```bash
67
+ # Run linting
68
+ just lint
69
+
70
+ # Run linting with auto-fix
71
+ just lint-fix
72
+
73
+ # Format code
74
+ just format
75
+
76
+ # Type checking
77
+ just type-check
78
+
79
+ # Run tests
80
+ just test
81
+
82
+ # Run tests with coverage
83
+ just test-cov
84
+ ```
85
+
86
+ ## Requirements
87
+
88
+ - Python 3.10+
89
+ - The actual `nameparser` library (this package only provides type stubs)
90
+
91
+ ## License
92
+
93
+ This project is licensed under the same terms as the original `nameparser` library.
94
+
95
+ ## Contributing
96
+
97
+ Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
98
+
99
+ ## Related Projects
100
+
101
+ - [nameparser](https://github.com/derek73/python-nameparser) - The original name parsing library
102
+ - [typeshed](https://github.com/python/typeshed) - Collection of type stubs for Python standard library and third-party packages
types_nameparser-0.3.1/nameparser_stubs/__init__.pyi ADDED
@@ -0,0 +1,101 @@
1
+ """
2
+ Stub file for nameparser module.
3
+
4
+ This stub provides type information for the nameparser library,
5
+ specifically the HumanName class used for parsing human names.
6
+ """
7
+
8
+ class HumanName:
9
+ """
10
+ A class for parsing human names into their component parts.
11
+
12
+ This class takes a full name string and parses it into first name,
13
+ last name, middle name, and other components.
14
+ """
15
+
16
+ def __init__(self, full_name: str) -> None:
17
+ """
18
+ Initialize HumanName with a full name string.
19
+
20
+ Args:
21
+ full_name: The full name to parse (e.g., "John Michael Smith")
22
+ """
23
+ ...
24
+
25
+ @property
26
+ def first(self) -> str:
27
+ """
28
+ The first name component.
29
+
30
+ Returns:
31
+ The first name as a string, empty string if not found
32
+ """
33
+ ...
34
+
35
+ @property
36
+ def last(self) -> str:
37
+ """
38
+ The last name component.
39
+
40
+ Returns:
41
+ The last name as a string, empty string if not found
42
+ """
43
+ ...
44
+
45
+ @property
46
+ def middle(self) -> str:
47
+ """
48
+ The middle name component.
49
+
50
+ Returns:
51
+ The middle name as a string, empty string if not found
52
+ """
53
+ ...
54
+
55
+ @property
56
+ def title(self) -> str:
57
+ """
58
+ The title component (Mr., Mrs., Dr., etc.).
59
+
60
+ Returns:
61
+ The title as a string, empty string if not found
62
+ """
63
+ ...
64
+
65
+ @property
66
+ def suffix(self) -> str:
67
+ """
68
+ The suffix component (Jr., Sr., III, etc.).
69
+
70
+ Returns:
71
+ The suffix as a string, empty string if not found
72
+ """
73
+ ...
74
+
75
+ @property
76
+ def nickname(self) -> str:
77
+ """
78
+ The nickname component.
79
+
80
+ Returns:
81
+ The nickname as a string, empty string if not found
82
+ """
83
+ ...
84
+
85
+ def __str__(self) -> str:
86
+ """
87
+ String representation of the parsed name.
88
+
89
+ Returns:
90
+ The full name as a string
91
+ """
92
+ ...
93
+
94
+ def __repr__(self) -> str:
95
+ """
96
+ String representation for debugging.
97
+
98
+ Returns:
99
+ A string representation of the HumanName object
100
+ """
101
+ ...
types_nameparser-0.3.1/pyproject.toml ADDED
@@ -0,0 +1,53 @@
1
+ [build-system]
2
+ requires = ["setuptools>=69", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "types-nameparser"
7
+ version = "0.3.1"
8
+ description = "Typing stubs for the nameparser library"
9
+ readme = "README.md"
10
+ requires-python = ">=3.8"
11
+ license = {text = "MIT"}
12
+ authors = [
13
+ {name = "Lucian Buzzo", email = "lucian.buzzo@gmail.com"}
14
+ ]
15
+ maintainers = [
16
+ {name = "Lucian Buzzo", email = "lucian.buzzo@gmail.com"}
17
+ ]
18
+ keywords = ["typing", "stubs", "nameparser", "type-hints"]
19
+ classifiers = [
20
+ "Development Status :: 4 - Beta",
21
+ "Intended Audience :: Developers",
22
+ "License :: OSI Approved :: MIT License",
23
+ "Operating System :: OS Independent",
24
+ "Programming Language :: Python :: 3",
25
+ "Programming Language :: Python :: 3.8",
26
+ "Programming Language :: Python :: 3.9",
27
+ "Programming Language :: Python :: 3.10",
28
+ "Programming Language :: Python :: 3.11",
29
+ "Programming Language :: Python :: 3.12",
30
+ "Topic :: Software Development :: Libraries :: Python Modules",
31
+ "Topic :: Software Development :: Quality Assurance",
32
+ "Typing :: Stubs Only",
33
+ ]
34
+
35
+ [tool.setuptools]
36
+ packages = ["nameparser_stubs"]
37
+ package-data = {"nameparser_stubs" = ["*.pyi"]}
38
+
39
+ [dependency-groups]
40
+ dev = [
41
+ "ruff>=0.13.0",
42
+ ]
43
+
44
+ [tool.ruff]
45
+ target-version = "py310"
46
+ line-length = 88
47
+
48
+ [tool.ruff.lint]
49
+ select = ["E", "F", "W", "I", "N", "UP", "B", "A", "C4", "T20", "SIM", "ARG", "PIE", "TCH", "Q", "RUF"]
50
+ ignore = []
51
+
52
+ [tool.ruff.lint.per-file-ignores]
53
+ "*.pyi" = ["F401", "F403", "F405", "F811", "F841", "PIE790"]
types_nameparser-0.3.1/setup.cfg ADDED
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
types_nameparser-0.3.1/types_nameparser.egg-info/PKG-INFO ADDED
@@ -0,0 +1,126 @@
1
+ Metadata-Version: 2.4
2
+ Name: types-nameparser
3
+ Version: 0.3.1
4
+ Summary: Typing stubs for the nameparser library
5
+ Author-email: Lucian Buzzo <lucian.buzzo@gmail.com>
6
+ Maintainer-email: Lucian Buzzo <lucian.buzzo@gmail.com>
7
+ License: MIT
8
+ Keywords: typing,stubs,nameparser,type-hints
9
+ Classifier: Development Status :: 4 - Beta
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: License :: OSI Approved :: MIT License
12
+ Classifier: Operating System :: OS Independent
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.8
15
+ Classifier: Programming Language :: Python :: 3.9
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
20
+ Classifier: Topic :: Software Development :: Quality Assurance
21
+ Classifier: Typing :: Stubs Only
22
+ Requires-Python: >=3.8
23
+ Description-Content-Type: text/markdown
24
+
25
+ # types-nameparser
26
+
27
+ [![PyPI version](https://badge.fury.io/py/types-nameparser.svg)](https://badge.fury.io/py/types-nameparser)
28
+ [![Python versions](https://img.shields.io/pypi/pyversions/types-nameparser.svg)](https://pypi.org/project/types-nameparser/)
29
+
30
+ Typing stubs for the [nameparser](https://github.com/derek73/python-nameparser) library.
31
+
32
+ ## Overview
33
+
34
+ This package provides type information (stub files) for the `nameparser` library, enabling better IDE support and static type checking when working with human name parsing functionality.
35
+
36
+ The `nameparser` library is a Python library for parsing human names into their component parts (first name, last name, middle name, title, suffix, etc.), but it doesn't include type hints. This package fills that gap by providing comprehensive type stubs.
37
+
38
+ ## Installation
39
+
40
+ ```bash
41
+ pip install types-nameparser
42
+ ```
43
+
44
+ Or if you're using [uv](https://github.com/astral-sh/uv):
45
+
46
+ ```bash
47
+ uv add types-nameparser
48
+ ```
49
+
50
+ ## Usage
51
+
52
+ After installation, you can use the type stubs with your existing `nameparser` code:
53
+
54
+ ```python
55
+ from nameparser import HumanName
56
+
57
+ # Now you get full type hints and IDE support!
58
+ name = HumanName("Dr. John Michael Smith Jr.")
59
+ print(name.first) # "John"
60
+ print(name.last) # "Smith"
61
+ print(name.middle) # "Michael"
62
+ print(name.title) # "Dr."
63
+ print(name.suffix) # "Jr."
64
+ ```
65
+
66
+ ## Type Information
67
+
68
+ The stubs provide type information for the `HumanName` class with the following properties:
69
+
70
+ - `first: str` - First name component
71
+ - `last: str` - Last name component
72
+ - `middle: str` - Middle name component
73
+ - `title: str` - Title component (Mr., Mrs., Dr., etc.)
74
+ - `suffix: str` - Suffix component (Jr., Sr., III, etc.)
75
+ - `nickname: str` - Nickname component
76
+
77
+ ## Development
78
+
79
+ This project uses [uv](https://github.com/astral-sh/uv) for dependency management and [just](https://github.com/casey/just) for task running.
80
+
81
+ ### Setup
82
+
83
+ ```bash
84
+ # Install dependencies
85
+ just install
86
+ ```
87
+
88
+ ### Available Commands
89
+
90
+ ```bash
91
+ # Run linting
92
+ just lint
93
+
94
+ # Run linting with auto-fix
95
+ just lint-fix
96
+
97
+ # Format code
98
+ just format
99
+
100
+ # Type checking
101
+ just type-check
102
+
103
+ # Run tests
104
+ just test
105
+
106
+ # Run tests with coverage
107
+ just test-cov
108
+ ```
109
+
110
+ ## Requirements
111
+
112
+ - Python 3.10+
113
+ - The actual `nameparser` library (this package only provides type stubs)
114
+
115
+ ## License
116
+
117
+ This project is licensed under the same terms as the original `nameparser` library.
118
+
119
+ ## Contributing
120
+
121
+ Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
122
+
123
+ ## Related Projects
124
+
125
+ - [nameparser](https://github.com/derek73/python-nameparser) - The original name parsing library
126
+ - [typeshed](https://github.com/python/typeshed) - Collection of type stubs for Python standard library and third-party packages
types_nameparser-0.3.1/types_nameparser.egg-info/SOURCES.txt ADDED
@@ -0,0 +1,7 @@
1
+ README.md
2
+ pyproject.toml
3
+ nameparser_stubs/__init__.pyi
4
+ types_nameparser.egg-info/PKG-INFO
5
+ types_nameparser.egg-info/SOURCES.txt
6
+ types_nameparser.egg-info/dependency_links.txt
7
+ types_nameparser.egg-info/top_level.txt
types_nameparser-0.3.1/types_nameparser.egg-info/top_level.txt ADDED
@@ -0,0 +1 @@
1
+ nameparser_stubs