python-disposable 0.0.2__tar.gz → 0.0.4__tar.gz

python_disposable-0.0.4/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: python-disposable
+Version: 0.0.4
+Summary: Check if an email address or domain belongs to a disposable/temporary email service. Bundles 72k+ domains from disposable/disposable-email-domains.
+Project-URL: Homepage, https://github.com/pescheckit/python-disposable
+Project-URL: Source, https://github.com/pescheckit/python-disposable
+Project-URL: Issues, https://github.com/pescheckit/python-disposable/issues
+License: MIT
+License-File: LICENSE
+Keywords: disposable,email,spam,validation
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Communications :: Email
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == 'test'
+Description-Content-Type: text/markdown
+
+# python-disposable
+
+A lightweight Python package to detect disposable/temporary email addresses. Bundles **72,000+ domains** from [disposable/disposable-email-domains](https://github.com/disposable/disposable-email-domains), updated daily — no network calls at runtime.
+
+## Installation
+
+```bash
+pip install python-disposable
+```
+
+## Usage
+
+### Basic check
+
+```python
+from disposable_email import is_disposable, is_valid
+
+is_disposable("user@mailinator.com")  # True
+is_disposable("user@gmail.com")       # False
+
+# Works with bare domains too
+is_disposable("guerrillamail.com")    # True
+
+# Inverse
+is_valid("user@gmail.com")            # True
+```
+
+### Strict mode
+
+Strict mode also flags greylisted domains — services that allow anonymous signups but aren't purely disposable (e.g. some free email providers).
+
+```python
+is_disposable("example.com", strict=True)
+is_valid("example.com", strict=True)
+```
+
+### Subdomain handling
+
+Subdomains are automatically resolved to their parent domain.
+
+```python
+is_disposable("mail.mailinator.com")     # True
+is_disposable("a.b.guerrillamail.com")   # True
+```
+
+### Get the full domain set
+
+```python
+from disposable_email import get_domains
+
+domains = get_domains()              # frozenset of 72k+ domains
+domains_strict = get_domains(strict=True)  # frozenset of strict list
+```
+
+### Domain count
+
+```python
+from disposable_email import domain_count
+
+domain_count()              # 72170
+domain_count(strict=True)   # 26468
+```
+
+## Django example
+
+```python
+from django import forms
+from disposable_email import is_disposable
+
+class RegisterForm(forms.Form):
+    email = forms.EmailField()
+
+    def clean_email(self):
+        email = self.cleaned_data["email"]
+        if is_disposable(email):
+            raise forms.ValidationError("Disposable email addresses are not allowed.")
+        return email
+```
+
+## API reference
+
+| Function | Description |
+|----------|-------------|
+| `is_disposable(email_or_domain, strict=False)` | Returns `True` if the email/domain is disposable |
+| `is_valid(email_or_domain, strict=False)` | Returns `True` if the email/domain is **not** disposable |
+| `get_domains(strict=False)` | Returns the full `frozenset` of known disposable domains |
+| `domain_count(strict=False)` | Returns the number of bundled domains |
+
+## Data source
+
+Domain lists are sourced from [disposable/disposable-email-domains](https://github.com/disposable/disposable-email-domains) and bundled at release time. The upstream list is updated daily via automated scraping of 40+ sources.
+
+This package checks for upstream updates every 4 hours and automatically publishes a new version to PyPI when changes are detected.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

python_disposable-0.0.4/README.md

@@ -0,0 +1,97 @@
+# python-disposable
+
+A lightweight Python package to detect disposable/temporary email addresses. Bundles **72,000+ domains** from [disposable/disposable-email-domains](https://github.com/disposable/disposable-email-domains), updated daily — no network calls at runtime.
+
+## Installation
+
+```bash
+pip install python-disposable
+```
+
+## Usage
+
+### Basic check
+
+```python
+from disposable_email import is_disposable, is_valid
+
+is_disposable("user@mailinator.com")  # True
+is_disposable("user@gmail.com")       # False
+
+# Works with bare domains too
+is_disposable("guerrillamail.com")    # True
+
+# Inverse
+is_valid("user@gmail.com")            # True
+```
+
+### Strict mode
+
+Strict mode also flags greylisted domains — services that allow anonymous signups but aren't purely disposable (e.g. some free email providers).
+
+```python
+is_disposable("example.com", strict=True)
+is_valid("example.com", strict=True)
+```
+
+### Subdomain handling
+
+Subdomains are automatically resolved to their parent domain.
+
+```python
+is_disposable("mail.mailinator.com")     # True
+is_disposable("a.b.guerrillamail.com")   # True
+```
+
+### Get the full domain set
+
+```python
+from disposable_email import get_domains
+
+domains = get_domains()              # frozenset of 72k+ domains
+domains_strict = get_domains(strict=True)  # frozenset of strict list
+```
+
+### Domain count
+
+```python
+from disposable_email import domain_count
+
+domain_count()              # 72170
+domain_count(strict=True)   # 26468
+```
+
+## Django example
+
+```python
+from django import forms
+from disposable_email import is_disposable
+
+class RegisterForm(forms.Form):
+    email = forms.EmailField()
+
+    def clean_email(self):
+        email = self.cleaned_data["email"]
+        if is_disposable(email):
+            raise forms.ValidationError("Disposable email addresses are not allowed.")
+        return email
+```
+
+## API reference
+
+| Function | Description |
+|----------|-------------|
+| `is_disposable(email_or_domain, strict=False)` | Returns `True` if the email/domain is disposable |
+| `is_valid(email_or_domain, strict=False)` | Returns `True` if the email/domain is **not** disposable |
+| `get_domains(strict=False)` | Returns the full `frozenset` of known disposable domains |
+| `domain_count(strict=False)` | Returns the number of bundled domains |
+
+## Data source
+
+Domain lists are sourced from [disposable/disposable-email-domains](https://github.com/disposable/disposable-email-domains) and bundled at release time. The upstream list is updated daily via automated scraping of 40+ sources.
+
+This package checks for upstream updates every 4 hours and automatically publishes a new version to PyPI when changes are detected.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

{python_disposable-0.0.2 → python_disposable-0.0.4}/disposable_email/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.0.2'
-__version_tuple__ = version_tuple = (0, 0, 2)
+__version__ = version = '0.0.4'
+__version_tuple__ = version_tuple = (0, 0, 4)
 
 __commit_id__ = commit_id = None