parseur-py 0.0.1__tar.gz

parseur_py-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Parseur
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

parseur_py-0.0.1/PKG-INFO

@@ -0,0 +1,242 @@
+Metadata-Version: 2.4
+Name: parseur-py
+Version: 0.0.1
+Summary: A Python client for the Parseur.com API to manage mailboxes, documents, uploads, and listen for new parsing events.
+Author-email: Parseur Team <admin@parseur.com>
+Project-URL: Homepage, https://github.com/parseur/parseur-py
+Project-URL: Repository, https://github.com/parseur/parseur-py
+Project-URL: Issues, https://github.com/parseur/parseur-py/issues
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.2.1
+Requires-Dist: requests>=2.31.0
+Requires-Dist: marshmallow>=4.0.0
+Dynamic: license-file
+
+# 🤖🧙parseur-py
+
+**parseur-py** is a modern Python client for the [Parseur](https://parseur.com) API. It lets you **manage mailboxes, documents, uploads, and webhooks** programmatically or from the command line.
+
+Built to help you automate document parsing at scale, parseur-py makes integrating with Parseur fast, easy, and Pythonic.
+
+[![GitHub Repo](https://img.shields.io/badge/GitHub-parseur--py-blue?logo=github)](https://github.com/parseur/parseur-py)
+[![PyPI version](https://badge.fury.io/py/parseur-py.svg)](https://badge.fury.io/py/parseur-py)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+---
+
+## ✨ Features
+
+✅ List, search, and sort mailboxes  
+✅ Get mailbox details and schema  
+✅ List, search, filter, and sort documents  
+✅ Upload documents by file or email content  
+✅ Reprocess, skip, copy, or delete documents  
+✅ Manage custom webhooks for real-time events  
+✅ Fully-featured **Command Line Interface (CLI)**
+
+---
+
+## 🚀 Quick Start
+
+### Install the package
+
+```bash
+pip install parseur-py
+```
+
+### Install the package from source
+
+```bash
+pip install -e .
+```
+
+### Build documentation
+
+```bash
+pip install -r requirements-doc.txt
+cd docs
+make html
+```
+
+---
+
+### Initialize your configuration
+
+Store your Parseur API credentials securely:
+
+```bash
+parseur init --api-key YOUR_PARSEUR_API_KEY
+```
+
+Your config is saved (by default) in:
+
+```
+~/.parseur.conf
+```
+
+---
+
+### Example usage
+
+List all your mailboxes:
+
+```bash
+parseur list-mailboxes
+```
+
+List documents in a mailbox:
+
+```bash
+parseur list-documents 12345
+```
+
+Upload a file to a mailbox:
+
+```bash
+parseur upload-file 12345 ./path/to/document.pdf
+```
+
+Register a custom webhook:
+
+```bash
+parseur create-webhook --event document.processed --target-url https://yourserver.com/webhook --mailbox-id 12345
+```
+
+---
+
+## 📜 CLI Commands
+
+Run:
+
+```bash
+parseur --help
+```
+
+for a full list of available commands.
+
+### Highlights
+
+- **init**: Set your API token and (optional) base URL  
+- **list-mailboxes**: Search and sort mailboxes  
+- **get-mailbox**: Fetch a mailbox by ID  
+- **get-mailbox-schema**: Get the mailbox parsing schema  
+- **list-documents**: Advanced document search, filtering, sorting  
+- **get-document**: Fetch document details  
+- **reprocess-document / skip-document / delete-document**: Document lifecycle operations  
+- **upload-file / upload-text**: Upload new documents  
+- **create-webhook / get-webhook / list-webhooks / delete-webhook**: Create, get, list, and delete custom webhook integrations.
+- **enable-webhook / pause-webhook**: Activate or pause a webhook for a specific mailbox.
+
+---
+
+## 🔎 Advanced Search & Filtering
+
+**Mailbox listing supports:**
+
+- **Search** by name or email prefix
+- **Sort** by:
+  - name
+  - document_count
+  - template_count
+  - PARSEDOK_count (processed)
+  - PARSEDKO_count (failed)
+  - QUOTAEXC_count (quota exceeded)
+  - EXPORTKO_count (export failed)
+
+**Document listing supports:**
+
+- **Search** in:
+  - document ID
+  - document name
+  - template name
+  - email addresses (from, to, cc, bcc)
+  - document metadata header
+- **Sort** by:
+  - name
+  - created (received date)
+  - processed date
+  - status
+- **Filter** by:
+  - received_after / received_before dates
+- **Include** parsed result in response
+
+---
+
+## ⚡ Webhooks Support
+
+Easily register custom webhooks for events like:
+
+- `document.processed`
+- `document.processed.flattened`
+- `document.template_needed`
+- `document.export_failed`
+- `table.processed`
+- `table.processed.flattened`
+
+Your webhook endpoint will receive POST notifications with Parseur payloads, enabling real-time integrations with your systems.
+
+---
+
+## 🛠️ Configuration
+
+Your API token and settings are stored in a simple INI file:
+
+```
+[parseur]
+api_token = YOUR_API_KEY
+base_url = https://api.parseur.com
+```
+
+You can customize the path by setting \`--config-path\` in your calls if needed.
+
+---
+
+## 🐍 Python Client Usage
+
+Beyond the CLI, **parseur-py** is a standard Python library. Example:
+
+```python
+import parseur
+
+parseur.api_key = "YOUR_API_KEY"
+
+for mailbox in parseur.Mailbox.list():
+    print(mailbox["name"])
+```
+
+---
+
+## 📖 Documentation
+
+- [Parseur Official API Docs](https://help.parseur.com/en/articles/3566128-use-parseur-document-parsing-api)
+- This package mirrors Parseur’s REST API, adding pagination handling, schema support, and convenient CLI commands.
+
+---
+
+## 💼 License
+
+MIT License
+
+---
+
+## 🤝 Contributing
+
+We welcome contributions! Please:
+
+1. Fork the repo
+2. Create your feature branch (`git checkout -b feature/foo`)
+3. Commit your changes (`git commit -am 'Add foo'`)
+4. Push to the branch (`git push origin feature/foo`)
+5. Open a pull request
+
+---
+
+## ✨ Credits
+
+Developed with ❤️ by the [Parseur](https://parseur.com) team.
+
+---
+
+*Parseur is the easiest way to automatically extract data from emails and documents. Stop copy-pasting data and automate your workflows!*

parseur_py-0.0.1/README.md

@@ -0,0 +1,226 @@
+# 🤖🧙parseur-py
+
+**parseur-py** is a modern Python client for the [Parseur](https://parseur.com) API. It lets you **manage mailboxes, documents, uploads, and webhooks** programmatically or from the command line.
+
+Built to help you automate document parsing at scale, parseur-py makes integrating with Parseur fast, easy, and Pythonic.
+
+[![GitHub Repo](https://img.shields.io/badge/GitHub-parseur--py-blue?logo=github)](https://github.com/parseur/parseur-py)
+[![PyPI version](https://badge.fury.io/py/parseur-py.svg)](https://badge.fury.io/py/parseur-py)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+---
+
+## ✨ Features
+
+✅ List, search, and sort mailboxes  
+✅ Get mailbox details and schema  
+✅ List, search, filter, and sort documents  
+✅ Upload documents by file or email content  
+✅ Reprocess, skip, copy, or delete documents  
+✅ Manage custom webhooks for real-time events  
+✅ Fully-featured **Command Line Interface (CLI)**
+
+---
+
+## 🚀 Quick Start
+
+### Install the package
+
+```bash
+pip install parseur-py
+```
+
+### Install the package from source
+
+```bash
+pip install -e .
+```
+
+### Build documentation
+
+```bash
+pip install -r requirements-doc.txt
+cd docs
+make html
+```
+
+---
+
+### Initialize your configuration
+
+Store your Parseur API credentials securely:
+
+```bash
+parseur init --api-key YOUR_PARSEUR_API_KEY
+```
+
+Your config is saved (by default) in:
+
+```
+~/.parseur.conf
+```
+
+---
+
+### Example usage
+
+List all your mailboxes:
+
+```bash
+parseur list-mailboxes
+```
+
+List documents in a mailbox:
+
+```bash
+parseur list-documents 12345
+```
+
+Upload a file to a mailbox:
+
+```bash
+parseur upload-file 12345 ./path/to/document.pdf
+```
+
+Register a custom webhook:
+
+```bash
+parseur create-webhook --event document.processed --target-url https://yourserver.com/webhook --mailbox-id 12345
+```
+
+---
+
+## 📜 CLI Commands
+
+Run:
+
+```bash
+parseur --help
+```
+
+for a full list of available commands.
+
+### Highlights
+
+- **init**: Set your API token and (optional) base URL  
+- **list-mailboxes**: Search and sort mailboxes  
+- **get-mailbox**: Fetch a mailbox by ID  
+- **get-mailbox-schema**: Get the mailbox parsing schema  
+- **list-documents**: Advanced document search, filtering, sorting  
+- **get-document**: Fetch document details  
+- **reprocess-document / skip-document / delete-document**: Document lifecycle operations  
+- **upload-file / upload-text**: Upload new documents  
+- **create-webhook / get-webhook / list-webhooks / delete-webhook**: Create, get, list, and delete custom webhook integrations.
+- **enable-webhook / pause-webhook**: Activate or pause a webhook for a specific mailbox.
+
+---
+
+## 🔎 Advanced Search & Filtering
+
+**Mailbox listing supports:**
+
+- **Search** by name or email prefix
+- **Sort** by:
+  - name
+  - document_count
+  - template_count
+  - PARSEDOK_count (processed)
+  - PARSEDKO_count (failed)
+  - QUOTAEXC_count (quota exceeded)
+  - EXPORTKO_count (export failed)
+
+**Document listing supports:**
+
+- **Search** in:
+  - document ID
+  - document name
+  - template name
+  - email addresses (from, to, cc, bcc)
+  - document metadata header
+- **Sort** by:
+  - name
+  - created (received date)
+  - processed date
+  - status
+- **Filter** by:
+  - received_after / received_before dates
+- **Include** parsed result in response
+
+---
+
+## ⚡ Webhooks Support
+
+Easily register custom webhooks for events like:
+
+- `document.processed`
+- `document.processed.flattened`
+- `document.template_needed`
+- `document.export_failed`
+- `table.processed`
+- `table.processed.flattened`
+
+Your webhook endpoint will receive POST notifications with Parseur payloads, enabling real-time integrations with your systems.
+
+---
+
+## 🛠️ Configuration
+
+Your API token and settings are stored in a simple INI file:
+
+```
+[parseur]
+api_token = YOUR_API_KEY
+base_url = https://api.parseur.com
+```
+
+You can customize the path by setting \`--config-path\` in your calls if needed.
+
+---
+
+## 🐍 Python Client Usage
+
+Beyond the CLI, **parseur-py** is a standard Python library. Example:
+
+```python
+import parseur
+
+parseur.api_key = "YOUR_API_KEY"
+
+for mailbox in parseur.Mailbox.list():
+    print(mailbox["name"])
+```
+
+---
+
+## 📖 Documentation
+
+- [Parseur Official API Docs](https://help.parseur.com/en/articles/3566128-use-parseur-document-parsing-api)
+- This package mirrors Parseur’s REST API, adding pagination handling, schema support, and convenient CLI commands.
+
+---
+
+## 💼 License
+
+MIT License
+
+---
+
+## 🤝 Contributing
+
+We welcome contributions! Please:
+
+1. Fork the repo
+2. Create your feature branch (`git checkout -b feature/foo`)
+3. Commit your changes (`git commit -am 'Add foo'`)
+4. Push to the branch (`git push origin feature/foo`)
+5. Open a pull request
+
+---
+
+## ✨ Credits
+
+Developed with ❤️ by the [Parseur](https://parseur.com) team.
+
+---
+
+*Parseur is the easiest way to automatically extract data from emails and documents. Stop copy-pasting data and automate your workflows!*

parseur_py-0.0.1/parseur/__init__.py

@@ -0,0 +1,31 @@
+from pathlib import Path
+
+from parseur.config import Config
+from parseur.document import Document, DocumentOrderKey
+from parseur.event import ParseurEvent
+from parseur.mailbox import Mailbox, MailboxOrderKey
+from parseur.schemas.document import DocumentStatus
+from parseur.utils import to_json
+from parseur.webhook import Webhook
+
+__all__ = [
+    "Config",
+    "Document",
+    "DocumentOrderKey",
+    "DocumentStatus",
+    "Mailbox",
+    "MailboxOrderKey",
+    "ParseurEvent",
+    "Webhook",
+    "to_json",
+]
+
+
+CONFIG_PATH = Path.home() / ".parseur.conf"
+config = Config(CONFIG_PATH)
+config.load()
+
+DEFAULT_API_BASE = "https://api.parseur.com"
+
+api_key = config.api_key
+api_base = config.api_base or DEFAULT_API_BASE