https://github.com/y-bar/netcleanser
The library makes parsing and manipulation of URL🌐 and Email address📧 easy.
https://github.com/y-bar/netcleanser
data-preprocessing email-to-domain python url-parsing url-verifier
Last synced: about 1 month ago
JSON representation
The library makes parsing and manipulation of URL🌐 and Email address📧 easy.
- Host: GitHub
- URL: https://github.com/y-bar/netcleanser
- Owner: y-bar
- License: mit
- Created: 2021-05-11T11:04:09.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-24T07:06:56.000Z (almost 5 years ago)
- Last Synced: 2025-12-16T09:24:31.825Z (5 months ago)
- Topics: data-preprocessing, email-to-domain, python, url-parsing, url-verifier
- Language: Python
- Homepage:
- Size: 40 KB
- Stars: 3
- Watchers: 7
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# netcleanser
The library makes parsing and manipulation of URL🌐 and Email address📧 easy.
[](https://github.com/y-bar/netcleanser/actions/workflows/ci.yml)
[](https://github.com/y-bar/netcleanser/blob/master/LICENSE)
[](https://github.com/y-bar/netcleanser/releases/latest)
[](https://pypi.org/project/netcleanser/)
[](https://pypi.org/project/netcleanser)
## Install
```bash
pip install netcleanser
```
## How to use
### Email
```python
>>> from netcleanser import Email
>>> email = Email('shinichi.takayanagi@gmail.com')
>>> email.domain
'gmail.com'
>>> email.local_part
'shinichi.takayanagi'
>>> email.is_valid
True
>>> email.value
'shinichi.takayanagi@gmail.com'
```
This `Email` class is `settable` and `dictable`
```python
# As a dict key
>>> x = {email: 1}
>>> x[email]
1
# As elemtns of set
>>> email2 = Email("nakamichiworks@gmail.com")
>>> {email, email, email, email2, email2}
{Email(value='nakamichiworks@gmail.com)', Email(value='shinichi.takayanagi@gmail.com)'}
```
`Email.build()` allows you to create dummy email address specifing the only part of `local_part` or `domain`
```python
>>> Email.build(local_part = "hoge")
Email(value='hoge@dummy.com)'
>>> Email.build(domain = "hoge.com")
Email(value='dummy@hoge.com)'
```
### Url
```python
>>> from netcleanser import Url
>>> url = Url('https://www.google.com/search?q=auhuhe')
>>> url.scheme
'https'
>>> url.host
'www.google.com'
>>> url.domain
'www.google.com'
>>> url.registered_domain
'google.com'
>>> url.netloc
'www.google.com'
>>> url.path
'/search'
>>> url.query
'q=auhuhe'
>>> url.is_valid
True
>>> url.is_accessible
True
>>> url.value
'https://www.google.com/search?q=auhuhe'
>>> str(url)
'https://www.google.com/search?q=auhuhe'
>>> url.contains_www
True
>>> url.remove_query()
Url(host='www.google.com', username='None', password='None', scheme='https', port='None', path='/search', query='', fragment='')
>>> url.remove_www()
Url(host='google.com', username='None', password='None', scheme='https', port='None', path='/search', query='q=auhuhe', fragment='')
```
This `Url` class is `settable` and `dictable`
```python
>>> x = {url: 123}
>>> x[Url('https://www.google.com/search?q=auhuhe')]
123
>>> {url, url, Url('https://google.com'), url}
{Url(host='www.google.com', username='None', password='None', scheme='https', port='None', path='/search', query='q=auhuhe', fragment=''), Url(host='google.com', username='None', password='None', scheme='https', port='None', path='', query='', fragment='')}
```
## Thanks
`Url` class strongly depends on awesome [purl](https://github.com/codeinthehole/purl) package, thanks!