edocapi 0.0.2__tar.gz

edocapi-0.0.2/AUTHORS.md

@@ -0,0 +1,12 @@
+# Authors
+
+**eDocAPI** is created and maintained by:
+
+| Field  | Value |
+|--------|-------|
+| Name   | EMMANUEL EMMANUEL ETIM |
+| Email  | emmanuel224etim089@gmail.com |
+| GitHub | https://github.com/emmanuelemmanueletim/edocApi |
+
+Copyright (c) 2026 EMMANUEL EMMANUEL ETIM.  
+Licensed under the MIT License — see `LICENSE`.

edocapi-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 EMMANUEL EMMANUEL ETIM
+
+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.

edocapi-0.0.2/MANIFEST.in

@@ -0,0 +1,11 @@
+include LICENSE
+include README.md
+include AUTHORS.md
+include PUBLISH.md
+include pyproject.toml
+recursive-include edocapi *.py
+recursive-exclude * __pycache__
+recursive-exclude * *.py[cod]
+prune tests
+prune .pytest_cache
+prune edocapi.egg-info

edocapi-0.0.2/PKG-INFO

@@ -0,0 +1,335 @@
+Metadata-Version: 2.4
+Name: edocapi
+Version: 0.0.2
+Summary: A lightweight Python framework for building document-processing and document-automation APIs.
+Author-email: EMMANUEL EMMANUEL ETIM <emmanuel224etim089@gmail.com>
+Maintainer-email: EMMANUEL EMMANUEL ETIM <emmanuel224etim089@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/emmanuelemmanueletim/edocApi
+Project-URL: Documentation, https://github.com/emmanuelemmanueletim/edocApi#readme
+Project-URL: Repository, https://github.com/emmanuelemmanueletim/edocApi.git
+Project-URL: Issues, https://github.com/emmanuelemmanueletim/edocApi/issues
+Keywords: document,api,pdf,docx,conversion,starlette,framework,document-processing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+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: Programming Language :: Python :: 3.13
+Classifier: Framework :: AsyncIO
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Text Processing
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: starlette>=0.37.0
+Requires-Dist: python-multipart>=0.0.9
+Requires-Dist: uvicorn[standard]>=0.27.0
+Requires-Dist: pypdf>=4.0.0
+Requires-Dist: python-docx>=1.1.0
+Requires-Dist: markdown>=3.5
+Requires-Dist: Pillow>=10.0.0
+Provides-Extra: html
+Requires-Dist: weasyprint>=61.0; extra == "html"
+Provides-Extra: pdf-images
+Requires-Dist: pdf2image>=1.17.0; extra == "pdf-images"
+Provides-Extra: all
+Requires-Dist: weasyprint>=61.0; extra == "all"
+Requires-Dist: pdf2image>=1.17.0; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Requires-Dist: httpx>=0.26.0; extra == "dev"
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: twine>=5.0.0; extra == "dev"
+Dynamic: license-file
+
+# eDocAPI
+
+**A lightweight Python framework for building document-processing and document-automation APIs.**
+
+> Simple API for the developer. Powerful document processing underneath.
+
+Built on [Starlette](https://www.starlette.io/). Version **0.0.2**.
+
+---
+
+## Installation
+
+**Core** (PDF, DOCX text/HTML, images, Markdown text/HTML, uploads, CLI):
+
+```bash
+pip install edocapi
+```
+
+**With HTML/Markdown/DOCX → PDF** (pulls in WeasyPrint):
+
+```bash
+pip install edocapi[html]
+```
+
+WeasyPrint needs system libraries. On Debian/Ubuntu:
+
+```bash
+sudo apt-get install -y libcairo2 libpango-1.0-0 libpangocairo-1.0-0 \
+  libgdk-pixbuf-2.0-0 libffi-dev shared-mime-info
+```
+
+**With PDF → images** (requires poppler):
+
+```bash
+pip install edocapi[pdf-images]
+# system: sudo apt-get install -y poppler-utils
+```
+
+**Everything:**
+
+```bash
+pip install edocapi[all]
+```
+
+**Development (from source):**
+
+```bash
+pip install -e ".[dev,html]"
+```
+
+## Build and publish
+
+From the repository root, build and check the package before uploading:
+
+```powershell
+py -m pip install --upgrade build twine
+py -m build
+py -m twine check dist/*
+py -m twine upload dist/*
+```
+
+Use `__token__` as the Twine username and your PyPI API token as the password
+when prompted. Do not commit the token. See [PUBLISH.md](PUBLISH.md) for the
+full checklist.
+
+---
+
+## Quick Start
+
+Create `main.py`:
+
+```python
+from edocapi import App, Document
+
+app = App()
+
+@app.post("/convert")
+def convert(file):
+    return Document(file).to_pdf()
+
+@app.post("/compress")
+def compress(file):
+    return Document(file).compress()
+
+@app.post("/extract")
+def extract(file):
+    return {"text": Document(file).extract_text()}
+
+@app.post("/merge")
+def merge(files):
+    return Document.merge(files)
+
+@app.get("/")
+def home():
+    return {"message": "eDocAPI v0.0.2", "supported": Document.supported_types()}
+```
+
+Run the development server:
+
+```bash
+edocapi run
+# or with auto-reload:
+edocapi run --reload
+```
+
+Upload a document to `POST /convert` and receive a PDF.
+
+---
+
+## Core Concepts
+
+### Application
+
+```python
+from edocapi import App
+
+app = App(
+    debug=True,
+    max_file_size="25MB",
+)
+```
+
+### Document
+
+```python
+from edocapi import Document
+
+# From uploaded file (Path)
+doc = Document(file)
+
+# From HTML string
+doc = Document.html("<h1>Invoice</h1><p>Total: ₦50,000</p>")
+
+# From Markdown
+doc = Document.markdown("# Hello World")
+```
+
+### Conversions
+
+```python
+Document(file).to_pdf()          # → Document (PDF)
+Document(file).to_text()         # → str
+Document(file).extract_text()    # → str
+Document(file).to_html()         # → str
+Document(file).to_images()       # → list[Document]
+```
+
+### PDF Operations
+
+```python
+Document(file).compress(level="medium")
+Document(file).split()                    # list of single-page Documents
+Document(file).extract_pages(1, 5)        # 1-based inclusive
+Document(file).rotate(90, pages=[1, 2])
+Document.merge([file1, file2])
+Document(file).info()                     # dict of metadata
+```
+
+---
+
+## Supported Formats (v0.0.2)
+
+| Input     | to_pdf | to_text | to_html | to_images | Notes                  |
+|-----------|--------|---------|---------|-----------|------------------------|
+| PDF       | ✓      | ✓       | ✓*      | ✓**       | *text-based HTML       |
+| DOCX      | ✓      | ✓       | ✓       | –         |                        |
+| HTML      | ✓      | ✓       | ✓       | –         |                        |
+| Markdown  | ✓      | ✓       | ✓       | –         |                        |
+| JPG/PNG/WEBP | ✓   | –       | –       | ✓         |                        |
+| TXT       | –      | ✓       | –       | –         | via Document constructor |
+
+\* PDF→HTML is a simple text extraction wrapper, not a visual rendering.  
+\*\* PDF→Images requires optional `pdf2image` + system poppler.
+
+---
+
+
+## Deploying
+
+The package exposes an ASGI application. In your application's `main.py`, create
+`app = App()` and start it with an ASGI server. For example:
+
+```bash
+uvicorn main:app.asgi --host 0.0.0.0 --port ${PORT:-8000} --workers 2
+```
+
+Keep `debug=False` in hosted environments. If you enable HTML-to-PDF conversion,
+install WeasyPrint's operating-system libraries in the image or host as well as
+the `html` extra. Set the reverse proxy's request-body limit to match
+`max_file_size`; for larger workloads, use a worker queue and monitor temporary
+disk usage.
+
+## Configuration
+
+```python
+app = App(
+    debug=False,           # more detailed errors when True
+    max_file_size="10MB",  # "10MB", "25MB", 10485760, etc.
+    temp_dir=None,         # custom temp directory (optional)
+)
+```
+
+---
+
+## Error Handling
+
+eDocAPI raises specific exceptions that become consistent JSON responses:
+
+```json
+{
+  "error": "UnsupportedFileType",
+  "message": "The uploaded file type is not supported. (extension: .xlsx)"
+}
+```
+
+Available exceptions: `EdocAPIError`, `UnsupportedFileType`, `InvalidDocument`, `FileTooLarge`, `FileNotFound`, `ConversionError`, `ProcessingError`, `ValidationError`.
+
+---
+
+## CLI
+
+```bash
+edocapi --version
+edocapi run                  # main:app on http://0.0.0.0:8000
+edocapi run --reload
+edocapi run myapp:app --port 8080
+```
+
+---
+
+## Architecture
+
+```
+eDocAPI
+   │
+   Document abstraction
+   │
+   +───────────+───────────+
+   │           │           │
+  PDF        DOCX        Images …
+   │           │           │
+ pypdf    python-docx   Pillow
+              │
+         weasyprint (HTML/PDF)
+```
+
+Processors are registered internally and can be extended in future versions.
+
+---
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+---
+
+
+## Release status
+
+eDocAPI is alpha software. Review conversion behavior, optional system
+dependencies, and workload limits before exposing it to untrusted public
+traffic. See [PUBLISH.md](PUBLISH.md) for the release checklist.
+
+## Roadmap
+
+- **v0.1** – OpenAPI generation, more formats, plugin system  
+- **v0.2** – OCR, background jobs, cloud storage adapters  
+- **v0.3+** – Document signing, AI integrations, advanced workflows  
+
+---
+
+## Author
+
+**EMMANUEL EMMANUEL ETIM**  
+Email: [emmanuel224etim089@gmail.com](mailto:emmanuel224etim089@gmail.com)  
+GitHub: [https://github.com/emmanuelemmanueletim/edocApi](https://github.com/emmanuelemmanueletim/edocApi)
+
+---
+
+## License
+
+MIT — Copyright (c) 2026 EMMANUEL EMMANUEL ETIM

edocapi-0.0.2/PUBLISH.md

@@ -0,0 +1,51 @@
+# Release checklist
+
+This document describes the release process. Publishing requires the maintainer's
+PyPI credentials and is a separate step from preparing the package.
+
+## Before release
+
+1. Update the version in `pyproject.toml`, `edocapi/__init__.py`, and README.
+2. Review the changes and run the project test suite on supported Python versions.
+3. Build and inspect both distributions:
+
+   ```bash
+   python -m pip install --upgrade build twine
+   python -m build
+   python -m twine check dist/*
+   ```
+
+4. Install the wheel in a clean environment and verify `import edocapi`, the
+   `edocapi --version` command, and the documented optional extras.
+5. Upload to TestPyPI and install the candidate package from a clean environment.
+
+## Publish
+
+Use a PyPI API token and Trusted Publishing where configured. Otherwise upload
+with Twine, entering `__token__` as the username and the token as the password:
+
+```bash
+python -m twine upload dist/*
+```
+
+Do not commit API tokens. A version already uploaded to PyPI cannot be replaced;
+increment the version for every follow-up release.
+
+For the first upload, build with an empty `dist/` directory so the command cannot
+accidentally include stale artifacts from an earlier version. Verify that the
+filenames are `edocapi-0.0.2.tar.gz` and `edocapi-0.0.2-py3-none-any.whl` before
+uploading.
+
+## Hosted deployment
+
+Create an application module exposing `app = App()` and run an ASGI server, for
+example:
+
+```bash
+uvicorn main:app.asgi --host 0.0.0.0 --port ${PORT:-8000} --workers 2
+```
+
+Use `debug=False`, configure the proxy body-size limit to match the app's upload
+limit, and install the required operating-system libraries for optional PDF
+conversions. Monitor temporary disk usage and use a queue for CPU-heavy or
+long-running document conversions.

edocapi-0.0.2/README.md

@@ -0,0 +1,285 @@
+# eDocAPI
+
+**A lightweight Python framework for building document-processing and document-automation APIs.**
+
+> Simple API for the developer. Powerful document processing underneath.
+
+Built on [Starlette](https://www.starlette.io/). Version **0.0.2**.
+
+---
+
+## Installation
+
+**Core** (PDF, DOCX text/HTML, images, Markdown text/HTML, uploads, CLI):
+
+```bash
+pip install edocapi
+```
+
+**With HTML/Markdown/DOCX → PDF** (pulls in WeasyPrint):
+
+```bash
+pip install edocapi[html]
+```
+
+WeasyPrint needs system libraries. On Debian/Ubuntu:
+
+```bash
+sudo apt-get install -y libcairo2 libpango-1.0-0 libpangocairo-1.0-0 \
+  libgdk-pixbuf-2.0-0 libffi-dev shared-mime-info
+```
+
+**With PDF → images** (requires poppler):
+
+```bash
+pip install edocapi[pdf-images]
+# system: sudo apt-get install -y poppler-utils
+```
+
+**Everything:**
+
+```bash
+pip install edocapi[all]
+```
+
+**Development (from source):**
+
+```bash
+pip install -e ".[dev,html]"
+```
+
+## Build and publish
+
+From the repository root, build and check the package before uploading:
+
+```powershell
+py -m pip install --upgrade build twine
+py -m build
+py -m twine check dist/*
+py -m twine upload dist/*
+```
+
+Use `__token__` as the Twine username and your PyPI API token as the password
+when prompted. Do not commit the token. See [PUBLISH.md](PUBLISH.md) for the
+full checklist.
+
+---
+
+## Quick Start
+
+Create `main.py`:
+
+```python
+from edocapi import App, Document
+
+app = App()
+
+@app.post("/convert")
+def convert(file):
+    return Document(file).to_pdf()
+
+@app.post("/compress")
+def compress(file):
+    return Document(file).compress()
+
+@app.post("/extract")
+def extract(file):
+    return {"text": Document(file).extract_text()}
+
+@app.post("/merge")
+def merge(files):
+    return Document.merge(files)
+
+@app.get("/")
+def home():
+    return {"message": "eDocAPI v0.0.2", "supported": Document.supported_types()}
+```
+
+Run the development server:
+
+```bash
+edocapi run
+# or with auto-reload:
+edocapi run --reload
+```
+
+Upload a document to `POST /convert` and receive a PDF.
+
+---
+
+## Core Concepts
+
+### Application
+
+```python
+from edocapi import App
+
+app = App(
+    debug=True,
+    max_file_size="25MB",
+)
+```
+
+### Document
+
+```python
+from edocapi import Document
+
+# From uploaded file (Path)
+doc = Document(file)
+
+# From HTML string
+doc = Document.html("<h1>Invoice</h1><p>Total: ₦50,000</p>")
+
+# From Markdown
+doc = Document.markdown("# Hello World")
+```
+
+### Conversions
+
+```python
+Document(file).to_pdf()          # → Document (PDF)
+Document(file).to_text()         # → str
+Document(file).extract_text()    # → str
+Document(file).to_html()         # → str
+Document(file).to_images()       # → list[Document]
+```
+
+### PDF Operations
+
+```python
+Document(file).compress(level="medium")
+Document(file).split()                    # list of single-page Documents
+Document(file).extract_pages(1, 5)        # 1-based inclusive
+Document(file).rotate(90, pages=[1, 2])
+Document.merge([file1, file2])
+Document(file).info()                     # dict of metadata
+```
+
+---
+
+## Supported Formats (v0.0.2)
+
+| Input     | to_pdf | to_text | to_html | to_images | Notes                  |
+|-----------|--------|---------|---------|-----------|------------------------|
+| PDF       | ✓      | ✓       | ✓*      | ✓**       | *text-based HTML       |
+| DOCX      | ✓      | ✓       | ✓       | –         |                        |
+| HTML      | ✓      | ✓       | ✓       | –         |                        |
+| Markdown  | ✓      | ✓       | ✓       | –         |                        |
+| JPG/PNG/WEBP | ✓   | –       | –       | ✓         |                        |
+| TXT       | –      | ✓       | –       | –         | via Document constructor |
+
+\* PDF→HTML is a simple text extraction wrapper, not a visual rendering.  
+\*\* PDF→Images requires optional `pdf2image` + system poppler.
+
+---
+
+
+## Deploying
+
+The package exposes an ASGI application. In your application's `main.py`, create
+`app = App()` and start it with an ASGI server. For example:
+
+```bash
+uvicorn main:app.asgi --host 0.0.0.0 --port ${PORT:-8000} --workers 2
+```
+
+Keep `debug=False` in hosted environments. If you enable HTML-to-PDF conversion,
+install WeasyPrint's operating-system libraries in the image or host as well as
+the `html` extra. Set the reverse proxy's request-body limit to match
+`max_file_size`; for larger workloads, use a worker queue and monitor temporary
+disk usage.
+
+## Configuration
+
+```python
+app = App(
+    debug=False,           # more detailed errors when True
+    max_file_size="10MB",  # "10MB", "25MB", 10485760, etc.
+    temp_dir=None,         # custom temp directory (optional)
+)
+```
+
+---
+
+## Error Handling
+
+eDocAPI raises specific exceptions that become consistent JSON responses:
+
+```json
+{
+  "error": "UnsupportedFileType",
+  "message": "The uploaded file type is not supported. (extension: .xlsx)"
+}
+```
+
+Available exceptions: `EdocAPIError`, `UnsupportedFileType`, `InvalidDocument`, `FileTooLarge`, `FileNotFound`, `ConversionError`, `ProcessingError`, `ValidationError`.
+
+---
+
+## CLI
+
+```bash
+edocapi --version
+edocapi run                  # main:app on http://0.0.0.0:8000
+edocapi run --reload
+edocapi run myapp:app --port 8080
+```
+
+---
+
+## Architecture
+
+```
+eDocAPI
+   │
+   Document abstraction
+   │
+   +───────────+───────────+
+   │           │           │
+  PDF        DOCX        Images …
+   │           │           │
+ pypdf    python-docx   Pillow
+              │
+         weasyprint (HTML/PDF)
+```
+
+Processors are registered internally and can be extended in future versions.
+
+---
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+---
+
+
+## Release status
+
+eDocAPI is alpha software. Review conversion behavior, optional system
+dependencies, and workload limits before exposing it to untrusted public
+traffic. See [PUBLISH.md](PUBLISH.md) for the release checklist.
+
+## Roadmap
+
+- **v0.1** – OpenAPI generation, more formats, plugin system  
+- **v0.2** – OCR, background jobs, cloud storage adapters  
+- **v0.3+** – Document signing, AI integrations, advanced workflows  
+
+---
+
+## Author
+
+**EMMANUEL EMMANUEL ETIM**  
+Email: [emmanuel224etim089@gmail.com](mailto:emmanuel224etim089@gmail.com)  
+GitHub: [https://github.com/emmanuelemmanueletim/edocApi](https://github.com/emmanuelemmanueletim/edocApi)
+
+---
+
+## License
+
+MIT — Copyright (c) 2026 EMMANUEL EMMANUEL ETIM