templatefox 1.0.0__tar.gz

templatefox-1.0.0/LICENSE

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

templatefox-1.0.0/PKG-INFO

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: templatefox
+Version: 1.0.0
+Summary: Official TemplateFox Python SDK - Generate PDFs from HTML templates
+Home-page: https://github.com/TemplateFoxPDF/pythonsdk
+Author: TemplateFox
+Author-email: TemplateFox <support@pdftemplateapi.com>
+License: MIT
+Project-URL: Repository, https://github.com/TemplateFoxPDF/pythonsdk
+Keywords: OpenAPI,OpenAPI-Generator,TemplateFox API
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+
+# TemplateFox Python SDK
+
+Official Python SDK for [TemplateFox](https://pdftemplateapi.com) - Generate PDFs from HTML templates via API.
+
+[![PyPI version](https://badge.fury.io/py/templatefox.svg)](https://pypi.org/project/templatefox/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Installation
+
+```bash
+pip install templatefox
+```
+
+Or with poetry:
+
+```bash
+poetry add templatefox
+```
+
+## Quick Start
+
+```python
+from templatefox import ApiClient, Configuration
+from templatefox.api import PDFApi
+from templatefox.models import CreatePdfRequest
+
+# Initialize the client
+config = Configuration()
+config.api_key['ApiKeyAuth'] = 'your-api-key'
+
+with ApiClient(config) as client:
+    api = PDFApi(client)
+
+    # Generate a PDF
+    response = api.create_pdf(
+        CreatePdfRequest(
+            template_id='YOUR_TEMPLATE_ID',
+            data={
+                'name': 'John Doe',
+                'invoice_number': 'INV-001',
+                'total_amount': 150.00,
+            }
+        )
+    )
+
+    print(f'PDF URL: {response.url}')
+    print(f'Credits remaining: {response.credits_remaining}')
+```
+
+## Features
+
+- **Template-based PDF generation** - Create templates with dynamic variables, generate PDFs with your data
+- **Multiple export options** - Get a signed URL (default) or raw binary PDF
+- **S3 integration** - Upload generated PDFs directly to your own S3-compatible storage
+- **Type hints** - Full type annotations for IDE support
+
+## API Methods
+
+### PDF Generation
+
+```python
+from templatefox.models import CreatePdfRequest
+
+# Generate PDF and get URL
+response = api.create_pdf(
+    CreatePdfRequest(
+        template_id='TEMPLATE_ID',
+        data={'name': 'John Doe'},
+        export_type='url',       # 'url' or 'binary'
+        expiration=86400,        # URL expiration in seconds (default: 24h)
+        filename='invoice-001'   # Custom filename
+    )
+)
+```
+
+### Templates
+
+```python
+from templatefox.api import TemplatesApi
+
+templates_api = TemplatesApi(client)
+
+# List all templates
+templates = templates_api.list_templates()
+for template in templates.templates:
+    print(f'{template.id}: {template.name}')
+
+# Get template fields
+fields = templates_api.get_template_fields(template_id='TEMPLATE_ID')
+for field in fields:
+    print(f'{field.key}: {field.type} (required: {field.required})')
+```
+
+### Account
+
+```python
+from templatefox.api import AccountApi
+
+account_api = AccountApi(client)
+
+# Get account info
+account = account_api.get_account()
+print(f'Credits: {account.credits}')
+print(f'Email: {account.email}')
+
+# List transactions
+transactions = account_api.list_transactions(limit=100, offset=0)
+for tx in transactions.transactions:
+    print(f'{tx.transaction_type}: {tx.credits} credits')
+```
+
+### S3 Integration
+
+```python
+from templatefox.api import IntegrationsApi
+from templatefox.models import S3ConfigRequest
+
+integrations_api = IntegrationsApi(client)
+
+# Save S3 configuration
+integrations_api.save_s3_config(
+    S3ConfigRequest(
+        endpoint_url='https://s3.amazonaws.com',
+        access_key_id='AKIAIOSFODNN7EXAMPLE',
+        secret_access_key='your-secret-key',
+        bucket_name='my-pdf-bucket',
+        default_prefix='generated/pdfs/'
+    )
+)
+
+# Test connection
+test = integrations_api.test_s3_connection()
+print(f'Connection: {"OK" if test.success else "Failed"}')
+```
+
+## Configuration
+
+```python
+from templatefox import Configuration
+
+config = Configuration(
+    host='https://api.pdftemplateapi.com',  # Default API URL
+)
+config.api_key['ApiKeyAuth'] = 'your-api-key'
+
+# Or use environment variable
+import os
+config.api_key['ApiKeyAuth'] = os.environ.get('TEMPLATEFOX_API_KEY')
+```
+
+## Error Handling
+
+```python
+from templatefox.exceptions import ApiException
+
+try:
+    response = api.create_pdf(CreatePdfRequest(...))
+except ApiException as e:
+    if e.status == 402:
+        print('Insufficient credits')
+    elif e.status == 403:
+        print('Access denied - check your API key')
+    elif e.status == 404:
+        print('Template not found')
+    else:
+        print(f'Error: {e.reason}')
+```
+
+## Async Support
+
+```python
+import asyncio
+from templatefox import ApiClient, Configuration
+from templatefox.api import PDFApi
+from templatefox.models import CreatePdfRequest
+
+async def generate_pdfs():
+    config = Configuration()
+    config.api_key['ApiKeyAuth'] = 'your-api-key'
+
+    async with ApiClient(config) as client:
+        api = PDFApi(client)
+        # Use async methods
+        response = await api.create_pdf(
+            CreatePdfRequest(template_id='...', data={...})
+        )
+
+asyncio.run(generate_pdfs())
+```
+
+## Documentation
+
+- [API Documentation](https://pdftemplateapi.com/docs)
+- [Swagger UI](https://api.pdftemplateapi.com/docs)
+- [Dashboard](https://pdftemplateapi.com/dashboard)
+
+## Support
+
+- Email: support@pdftemplateapi.com
+- Issues: [GitHub Issues](https://github.com/TemplateFoxPDF/pythonsdk/issues)
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

templatefox-1.0.0/README.md

@@ -0,0 +1,204 @@
+# TemplateFox Python SDK
+
+Official Python SDK for [TemplateFox](https://pdftemplateapi.com) - Generate PDFs from HTML templates via API.
+
+[![PyPI version](https://badge.fury.io/py/templatefox.svg)](https://pypi.org/project/templatefox/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Installation
+
+```bash
+pip install templatefox
+```
+
+Or with poetry:
+
+```bash
+poetry add templatefox
+```
+
+## Quick Start
+
+```python
+from templatefox import ApiClient, Configuration
+from templatefox.api import PDFApi
+from templatefox.models import CreatePdfRequest
+
+# Initialize the client
+config = Configuration()
+config.api_key['ApiKeyAuth'] = 'your-api-key'
+
+with ApiClient(config) as client:
+    api = PDFApi(client)
+
+    # Generate a PDF
+    response = api.create_pdf(
+        CreatePdfRequest(
+            template_id='YOUR_TEMPLATE_ID',
+            data={
+                'name': 'John Doe',
+                'invoice_number': 'INV-001',
+                'total_amount': 150.00,
+            }
+        )
+    )
+
+    print(f'PDF URL: {response.url}')
+    print(f'Credits remaining: {response.credits_remaining}')
+```
+
+## Features
+
+- **Template-based PDF generation** - Create templates with dynamic variables, generate PDFs with your data
+- **Multiple export options** - Get a signed URL (default) or raw binary PDF
+- **S3 integration** - Upload generated PDFs directly to your own S3-compatible storage
+- **Type hints** - Full type annotations for IDE support
+
+## API Methods
+
+### PDF Generation
+
+```python
+from templatefox.models import CreatePdfRequest
+
+# Generate PDF and get URL
+response = api.create_pdf(
+    CreatePdfRequest(
+        template_id='TEMPLATE_ID',
+        data={'name': 'John Doe'},
+        export_type='url',       # 'url' or 'binary'
+        expiration=86400,        # URL expiration in seconds (default: 24h)
+        filename='invoice-001'   # Custom filename
+    )
+)
+```
+
+### Templates
+
+```python
+from templatefox.api import TemplatesApi
+
+templates_api = TemplatesApi(client)
+
+# List all templates
+templates = templates_api.list_templates()
+for template in templates.templates:
+    print(f'{template.id}: {template.name}')
+
+# Get template fields
+fields = templates_api.get_template_fields(template_id='TEMPLATE_ID')
+for field in fields:
+    print(f'{field.key}: {field.type} (required: {field.required})')
+```
+
+### Account
+
+```python
+from templatefox.api import AccountApi
+
+account_api = AccountApi(client)
+
+# Get account info
+account = account_api.get_account()
+print(f'Credits: {account.credits}')
+print(f'Email: {account.email}')
+
+# List transactions
+transactions = account_api.list_transactions(limit=100, offset=0)
+for tx in transactions.transactions:
+    print(f'{tx.transaction_type}: {tx.credits} credits')
+```
+
+### S3 Integration
+
+```python
+from templatefox.api import IntegrationsApi
+from templatefox.models import S3ConfigRequest
+
+integrations_api = IntegrationsApi(client)
+
+# Save S3 configuration
+integrations_api.save_s3_config(
+    S3ConfigRequest(
+        endpoint_url='https://s3.amazonaws.com',
+        access_key_id='AKIAIOSFODNN7EXAMPLE',
+        secret_access_key='your-secret-key',
+        bucket_name='my-pdf-bucket',
+        default_prefix='generated/pdfs/'
+    )
+)
+
+# Test connection
+test = integrations_api.test_s3_connection()
+print(f'Connection: {"OK" if test.success else "Failed"}')
+```
+
+## Configuration
+
+```python
+from templatefox import Configuration
+
+config = Configuration(
+    host='https://api.pdftemplateapi.com',  # Default API URL
+)
+config.api_key['ApiKeyAuth'] = 'your-api-key'
+
+# Or use environment variable
+import os
+config.api_key['ApiKeyAuth'] = os.environ.get('TEMPLATEFOX_API_KEY')
+```
+
+## Error Handling
+
+```python
+from templatefox.exceptions import ApiException
+
+try:
+    response = api.create_pdf(CreatePdfRequest(...))
+except ApiException as e:
+    if e.status == 402:
+        print('Insufficient credits')
+    elif e.status == 403:
+        print('Access denied - check your API key')
+    elif e.status == 404:
+        print('Template not found')
+    else:
+        print(f'Error: {e.reason}')
+```
+
+## Async Support
+
+```python
+import asyncio
+from templatefox import ApiClient, Configuration
+from templatefox.api import PDFApi
+from templatefox.models import CreatePdfRequest
+
+async def generate_pdfs():
+    config = Configuration()
+    config.api_key['ApiKeyAuth'] = 'your-api-key'
+
+    async with ApiClient(config) as client:
+        api = PDFApi(client)
+        # Use async methods
+        response = await api.create_pdf(
+            CreatePdfRequest(template_id='...', data={...})
+        )
+
+asyncio.run(generate_pdfs())
+```
+
+## Documentation
+
+- [API Documentation](https://pdftemplateapi.com/docs)
+- [Swagger UI](https://api.pdftemplateapi.com/docs)
+- [Dashboard](https://pdftemplateapi.com/dashboard)
+
+## Support
+
+- Email: support@pdftemplateapi.com
+- Issues: [GitHub Issues](https://github.com/TemplateFoxPDF/pythonsdk/issues)
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

templatefox-1.0.0/pyproject.toml

@@ -0,0 +1,95 @@
+[project]
+name = "templatefox"
+version = "1.0.0"
+description = "Official TemplateFox Python SDK - Generate PDFs from HTML templates"
+license = {text = "MIT"}
+authors = [
+  {name = "TemplateFox",email = "support@pdftemplateapi.com"},
+]
+readme = "README.md"
+keywords = ["OpenAPI", "OpenAPI-Generator", "TemplateFox API"]
+requires-python = ">=3.9"
+
+dependencies = [
+  "urllib3 (>=2.1.0,<3.0.0)",
+  "python-dateutil (>=2.8.2)",
+  "pydantic (>=2)",
+  "typing-extensions (>=4.7.1)",
+]
+
+[project.urls]
+Repository = "https://github.com/TemplateFoxPDF/pythonsdk"
+
+[tool.poetry]
+requires-poetry = ">=2.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = ">= 7.2.1"
+pytest-cov = ">= 2.8.1"
+tox = ">= 3.9.0"
+flake8 = ">= 4.0.0"
+types-python-dateutil = ">= 2.8.19.14"
+mypy = ">= 1.5"
+
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.pylint.'MESSAGES CONTROL']
+extension-pkg-whitelist = "pydantic"
+
+[tool.mypy]
+files = [
+  "templatefox",
+  #"test",  # auto-generated tests
+  "tests", # hand-written tests
+]
+# TODO: enable "strict" once all these individual checks are passing
+# strict = true
+
+# List from: https://mypy.readthedocs.io/en/stable/existing_code.html#introduce-stricter-options
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+## Getting these passing should be easy
+strict_equality = true
+extra_checks = true
+
+## Strongly recommend enabling this one as soon as you can
+check_untyped_defs = true
+
+## These shouldn't be too much additional work, but may be tricky to
+## get passing if you use a lot of untyped libraries
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+
+### These next few are various gradations of forcing use of type annotations
+#disallow_untyped_calls = true
+#disallow_incomplete_defs = true
+#disallow_untyped_defs = true
+#
+### This one isn't too hard to get passing, but return on investment is lower
+#no_implicit_reexport = true
+#
+### This one can be tricky to get passing if you use a lot of untyped libraries
+#warn_return_any = true
+
+[[tool.mypy.overrides]]
+module = [
+  "templatefox.configuration",
+]
+warn_unused_ignores = true
+strict_equality = true
+extra_checks = true
+check_untyped_defs = true
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+disallow_untyped_calls = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+no_implicit_reexport = true
+warn_return_any = true

templatefox-1.0.0/setup.cfg

@@ -0,0 +1,7 @@
+[flake8]
+max-line-length = 99
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

templatefox-1.0.0/setup.py

@@ -0,0 +1,50 @@
+# coding: utf-8
+
+"""
+    TemplateFox API
+
+    Generate PDFs from HTML templates via API. Design once, generate thousands.
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: support@pdftemplateapi.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from setuptools import setup, find_packages  # noqa: H301
+
+# To install the library, run the following
+#
+# python setup.py install
+#
+# prerequisite: setuptools
+# http://pypi.python.org/pypi/setuptools
+NAME = "templatefox"
+VERSION = "1.0.0"
+PYTHON_REQUIRES = ">= 3.9"
+REQUIRES = [
+    "urllib3 >= 2.1.0, < 3.0.0",
+    "python-dateutil >= 2.8.2",
+    "pydantic >= 2",
+    "typing-extensions >= 4.7.1",
+]
+
+setup(
+    name=NAME,
+    version=VERSION,
+    description="TemplateFox API",
+    author="TemplateFox",
+    author_email="support@pdftemplateapi.com",
+    url="https://github.com/TemplateFoxPDF/pythonsdk",
+    keywords=["OpenAPI", "OpenAPI-Generator", "TemplateFox API"],
+    install_requires=REQUIRES,
+    packages=find_packages(exclude=["test", "tests"]),
+    include_package_data=True,
+    long_description_content_type='text/markdown',
+    long_description="""\
+    Generate PDFs from HTML templates via API. Design once, generate thousands.
+    """,  # noqa: E501
+    package_data={"templatefox": ["py.typed"]},
+)

templatefox-1.0.0/templatefox/__init__.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    TemplateFox API
+
+    Generate PDFs from HTML templates via API. Design once, generate thousands.
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: support@pdftemplateapi.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "AccountApi",
+    "IntegrationsApi",
+    "PDFApi",
+    "TemplatesApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "AccountInfoResponse",
+    "CreatePdfRequest",
+    "CreatePdfResponse",
+    "ExportType",
+    "HTTPValidationError",
+    "LocationInner",
+    "S3ConfigRequest",
+    "S3ConfigResponse",
+    "S3SuccessResponse",
+    "S3TestResponse",
+    "TemplateField",
+    "TemplateListItem",
+    "TemplatesListResponse",
+    "Transaction",
+    "TransactionsResponse",
+    "ValidationError",
+]
+
+# import apis into sdk package
+from templatefox.api.account_api import AccountApi as AccountApi
+from templatefox.api.integrations_api import IntegrationsApi as IntegrationsApi
+from templatefox.api.pdf_api import PDFApi as PDFApi
+from templatefox.api.templates_api import TemplatesApi as TemplatesApi
+
+# import ApiClient
+from templatefox.api_response import ApiResponse as ApiResponse
+from templatefox.api_client import ApiClient as ApiClient
+from templatefox.configuration import Configuration as Configuration
+from templatefox.exceptions import OpenApiException as OpenApiException
+from templatefox.exceptions import ApiTypeError as ApiTypeError
+from templatefox.exceptions import ApiValueError as ApiValueError
+from templatefox.exceptions import ApiKeyError as ApiKeyError
+from templatefox.exceptions import ApiAttributeError as ApiAttributeError
+from templatefox.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from templatefox.models.account_info_response import AccountInfoResponse as AccountInfoResponse
+from templatefox.models.create_pdf_request import CreatePdfRequest as CreatePdfRequest
+from templatefox.models.create_pdf_response import CreatePdfResponse as CreatePdfResponse
+from templatefox.models.export_type import ExportType as ExportType
+from templatefox.models.http_validation_error import HTTPValidationError as HTTPValidationError
+from templatefox.models.location_inner import LocationInner as LocationInner
+from templatefox.models.s3_config_request import S3ConfigRequest as S3ConfigRequest
+from templatefox.models.s3_config_response import S3ConfigResponse as S3ConfigResponse
+from templatefox.models.s3_success_response import S3SuccessResponse as S3SuccessResponse
+from templatefox.models.s3_test_response import S3TestResponse as S3TestResponse
+from templatefox.models.template_field import TemplateField as TemplateField
+from templatefox.models.template_list_item import TemplateListItem as TemplateListItem
+from templatefox.models.templates_list_response import TemplatesListResponse as TemplatesListResponse
+from templatefox.models.transaction import Transaction as Transaction
+from templatefox.models.transactions_response import TransactionsResponse as TransactionsResponse
+from templatefox.models.validation_error import ValidationError as ValidationError
+

templatefox-1.0.0/templatefox/api/__init__.py

@@ -0,0 +1,8 @@
+# flake8: noqa
+
+# import apis into api package
+from templatefox.api.account_api import AccountApi
+from templatefox.api.integrations_api import IntegrationsApi
+from templatefox.api.pdf_api import PDFApi
+from templatefox.api.templates_api import TemplatesApi
+