billkit 0.1.dev21__tar.gz

billkit-0.1.dev21/.gitignore

@@ -0,0 +1,222 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Generated files
+src/billkit/_version.py
+src/billkit/version.py
+*_version.py
+version.py

billkit-0.1.dev21/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+- repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
+  rev: v9.15.0  # Use latest
+  hooks:
+  - id: commitlint
+    stages: [commit-msg]
+    additional_dependencies: ['@commitlint/config-conventional']

billkit-0.1.dev21/LICENSE

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

billkit-0.1.dev21/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: billkit
+Version: 0.1.dev21
+Summary: Python client for Billkitco API
+Author-email: Billkit <billkitco@gmail.com>
+License: MIT
+Project-URL: Homepage, https://billkit.co
+Project-URL: Repository, https://github.com/billkitco/billkit-python
+Project-URL: Bug Tracker, https://github.com/billkitco/billkit-python/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.0
+Provides-Extra: dev
+Requires-Dist: pre-commit>=3.8.0; extra == "dev"
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: ruff>=0.5.0; extra == "dev"
+Requires-Dist: black>=24.0.0; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Dynamic: license-file
+
+# billkit-python

billkit-0.1.dev21/README.md

@@ -0,0 +1 @@
+# billkit-python

billkit-0.1.dev21/examples/basic_usage.py

@@ -0,0 +1,5 @@
+"""
+Basic usage example for Billkit API client.
+
+This example demonstrates how to initialize the client and make basic API calls.
+"""

billkit-0.1.dev21/examples/customers_example.py

@@ -0,0 +1,5 @@
+"""
+Example: Working with customers.
+
+This example demonstrates how to create, retrieve, update, and list customers.
+"""

billkit-0.1.dev21/examples/invoices_example.py

@@ -0,0 +1,5 @@
+"""
+Example: Working with invoices.
+
+This example demonstrates how to create, retrieve, update, and manage invoices.
+"""

billkit-0.1.dev21/examples/pdf_download_example.py

@@ -0,0 +1,5 @@
+"""
+Example: Downloading PDF documents.
+
+This example demonstrates how to download PDF invoices, quotes, or other documents.
+"""

billkit-0.1.dev21/examples/quotes_example.py

@@ -0,0 +1,5 @@
+"""
+Example: Working with quotes.
+
+This example demonstrates how to create, retrieve, update, and manage quotes.
+"""

billkit-0.1.dev21/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["setuptools>=61", "setuptools_scm>=7"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "billkit"
+dynamic = ["version"]
+description = "Python client for Billkitco API"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [{name = "Billkit", email = "billkitco@gmail.com"}]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+requires-python = ">=3.11"
+dependencies = [
+    "httpx>=0.27.0",
+    "pydantic>=2.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pre-commit>=3.8.0",
+    "pytest>=8.0.0",
+    "ruff>=0.5.0",
+    "black>=24.0.0",
+    "mypy>=1.10",
+]
+
+[project.urls]
+Homepage = "https://billkit.co"
+Repository = "https://github.com/billkitco/billkit-python"
+"Bug Tracker" = "https://github.com/billkitco/billkit-python/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools_scm]
+write_to = "src/billkit/_version.py"
+version_scheme = "guess-next-dev"
+local_scheme = "no-local-version"   # ← this removes +... suffix
+root = "."
+
+[tool.ruff]
+line-length = 88
+target-version = "py310"
+
+[tool.black]
+line-length = 88
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true

billkit-0.1.dev21/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

billkit-0.1.dev21/src/billkit/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.1.dev21'
+__version_tuple__ = version_tuple = (0, 1, 'dev21')
+
+__commit_id__ = commit_id = 'g2213f9e2a'

billkit-0.1.dev21/src/billkit/client.py

@@ -0,0 +1,44 @@
+import os
+import httpx
+from typing import Any
+
+
+class BillkitClient:
+    """
+    client for Billkitco invoicing API.
+
+    Usage:
+        client = BillkitClient()  # Uses BILLKITCO_API_KEY env var
+        client = BillkitClient(api_key="sk_...")
+    """
+
+    def __init__(
+        self, api_key: str | None = None, base_url: str = "https://api.billkit.co/v1"
+    ) -> None:
+        # Check env var first if no param
+        if api_key is None:
+            api_key = os.getenv("BILLKITCO_API_KEY")
+
+        if not api_key:
+            raise ValueError(
+                "API key required. Pass to BillkitClient(api_key='sk_...') "
+                "or set BILLKITCO_API_KEY environment variable."
+            )
+
+        self.api_key = api_key
+        self.base_url = base_url.rstrip("/")
+        self._client = httpx.Client(
+            base_url=self.base_url,
+            headers={"Authorization": f"Bearer {self.api_key}"},
+            timeout=30.0,
+        )
+
+    def _request(self, method: str, endpoint: str, **kwargs: Any) -> dict:
+        """Internal proxy to backend API endpoints."""
+        url: str = f"{self.base_url}/{endpoint.lstrip('/')}"
+        resp: httpx.Response = self._client.request(method, url, **kwargs)
+        resp.raise_for_status()
+        try:
+            return resp.json()
+        except ValueError:
+            return resp.text

billkit-0.1.dev21/src/billkit/models/enums.py

@@ -0,0 +1,30 @@
+from enum import StrEnum
+
+
+class _DocumentStyle(StrEnum):
+    ClassicLeftLogo = "Classic Left Logo"
+    ModernCenteredLogo = "Modern Centered Logo"
+    CompactSingleColumn = "Compact Single-Column"
+    DetailedBusinessVatTaxHeavy = "Detailed Business (VAT/Tax Heavy)"
+    ServicesTimeTrackingInvoice = "Services / Time-Tracking Invoice"
+    ProductItemisedInvoice = "Product / Itemised Invoice"
+    CreativeAgencyStyle = "Creative / Agency Style"
+    RetainerSubscriptionInvoice = "Retainer / Subscription Invoice"
+    MinimalMonochrome = "Minimal Monochrome"
+    BoldRightLogoLayout = "Bold Right-Logo Layout"
+
+
+    @classmethod
+    def as_invoice_style(cls) -> type[StrEnum]:
+        return StrEnum('InvoiceStyle', {name: value for name, value in cls.__members__.items()})
+    
+    @classmethod
+    def as_quote_style(cls) -> type[StrEnum]:
+        return StrEnum('QuoteStyle', {name: value for name, value in cls.__members__.items()})
+
+InvoiceStyle = _DocumentStyle.as_invoice_style()
+QuoteStyle = _DocumentStyle.as_quote_style()
+
+class DiscountType(StrEnum):
+    Percentage = "percentage"
+    Fixed = "fixed"

billkit-0.1.dev21/src/billkit/models/header.py

@@ -0,0 +1,19 @@
+from datetime import datetime
+from pydantic import BaseModel
+
+class _BaseHeader(BaseModel):
+    client_name: str
+    client_email: str
+    client_address: str
+    invoice_number: str
+    reference_number: str
+    po_number: str
+    invoice_date: str
+    due_date: datetime
+    currency_code: str | None = None
+    currency_symbol: str | None = None
+    invoice_type: str | None = None
+
+class QuoteHeader(_BaseHeader): ...
+
+class InvoiceHeader(_BaseHeader): ...

billkit-0.1.dev21/src/billkit/models/invoices.py

@@ -0,0 +1,77 @@
+from datetime import datetime
+from pydantic import BaseModel
+
+from .client import ClientDetails
+from .enums import InvoiceStyle
+from .items import ItemsBase, DiscountType
+from .sender import SenderDetails
+
+class InvoiceItem(ItemsBase): ...
+
+class InvoiceCreate(BaseModel):
+    """
+    Schema for creating a new invoice.
+
+    Defines all required and optional fields for an invoice, including client and sender
+    information, line items, dates, styling, and monetary details such as currency
+    and discount.
+
+    Attributes:
+        client_name: Full name of the client.
+        client_email: Email address of the client.
+        invoice_number: Unique identifier of the invoice.
+        due_date: Deadline by which the invoice must be paid.
+        item: List of line-item details for the invoice.
+
+        from_name: Name of the sender / issuing entity.
+        from_email: Email of the sender / issuing entity.
+        from_address: Physical or mailing address of the sender.
+
+        client_address: Optional physical or mailing address of the client.
+        reference_number: Optional external invoice or account reference.
+        po_number: Optional purchase order number.
+        _save_client: Whether to persist client details for reuse (internal flag).
+        invoice_date: Optional date when the invoice is issued; defaults to now.
+        style: Layout style for the rendered invoice (e.g., logo position etc.).
+        logo_url: Optional URL to the logo image to display on the invoice.
+        currency_code: ISO currency code (e.g., 'GBP', 'USD').
+        currency_symbol: Display symbol for the currency (e.g., '£', '$').
+
+        notes: Optional notes included on the invoice.
+        terms: Optional terms and conditions text.
+        discount_types: Type of discount applied (e.g., percentage vs fixed).
+        discount_value: Numeric value of the discount (default 0.0).
+    """
+    client_details: ClientDetails
+    invoice_number: str
+    due_date: datetime
+    items: list[InvoiceItem]
+
+    sender_details: SenderDetails | None = None
+
+    reference_number: str | None = None
+    po_number: str | None = None
+    invoice_date: datetime | None = None
+    style: InvoiceStyle = InvoiceStyle.ClassicLeftLogo
+    logo_url: str | None = None
+    """
+    Optional URL of a logo image to display on this invoice.
+    If omitted or None, the invoice will fall back to the logo saved in the client's account.
+    """
+    currency_code: str | None = None
+    currency_symbol: str | None = None
+    
+    notes: str | None = None
+    terms: str | None = None
+    discount_types: DiscountType | None = None
+    """
+    Document level discount. This applies the discount to all items before tax
+    """
+    discount_value: float = 0.0
+    """
+    Document level discount. This applies the discount to all items before tax
+    """
+    _save_client: bool = False
+    """
+    Whether to add client information to gui for autofill function. Largely irrelevant for programmatic access
+    """

billkit-0.1.dev21/src/billkit/models/items.py

@@ -0,0 +1,23 @@
+from decimal import Decimal
+
+from .enums import DiscountType
+
+from pydantic import BaseModel, Field, model_validator
+
+
+class ItemsBase(BaseModel):
+    description: str = Field(..., min_length=1)
+    qty: int = Field(..., gt=0)
+    price: Decimal = Field(..., gt=0)
+    tax: Decimal = Field(default=Decimal("0.00"), ge=0)
+    discount_type: DiscountType | None = None
+    discount_value: Decimal = Field(default=Decimal("0.00"), ge=0)
+
+    @model_validator(mode="after")
+    def validate_discount(self) -> "ItemsBase":
+        if self.discount_type is None:
+            self.discount_value = Decimal("0.00")
+            return self
+        if self.discount_type == DiscountType.Percentage and self.discount_value > 100:
+            raise ValueError("Percentage discount must be 100 or less")
+        return self

billkit-0.1.dev21/src/billkit/models/sender.py

@@ -0,0 +1,13 @@
+from pydantic import BaseModel
+
+class SenderDetails(BaseModel):
+    """
+    Sender (your business) details for invoices/quotes.
+
+    All fields are optional and default to your account settings if omitted.
+    If no account defaults exist, invoices will lack sender information.
+    Explicitly setting fields is recommended for reliability.
+    """
+    from_name: str | None = None
+    from_email: str | None = None
+    from_address: str | None = None

billkit-0.1.dev21/src/billkit/version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.1.dev20+g5a4ac962c'
+__version_tuple__ = version_tuple = (0, 1, 'dev20', 'g5a4ac962c')
+
+__commit_id__ = commit_id = 'g5a4ac962c'

billkit-0.1.dev21/src/billkit.egg-info/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: billkit
+Version: 0.1.dev21
+Summary: Python client for Billkitco API
+Author-email: Billkit <billkitco@gmail.com>
+License: MIT
+Project-URL: Homepage, https://billkit.co
+Project-URL: Repository, https://github.com/billkitco/billkit-python
+Project-URL: Bug Tracker, https://github.com/billkitco/billkit-python/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.0
+Provides-Extra: dev
+Requires-Dist: pre-commit>=3.8.0; extra == "dev"
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: ruff>=0.5.0; extra == "dev"
+Requires-Dist: black>=24.0.0; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Dynamic: license-file
+
+# billkit-python

billkit-0.1.dev21/src/billkit.egg-info/SOURCES.txt

@@ -0,0 +1,34 @@
+.gitignore
+.pre-commit-config.yaml
+LICENSE
+README.md
+pyproject.toml
+examples/basic_usage.py
+examples/customers_example.py
+examples/invoices_example.py
+examples/pdf_download_example.py
+examples/quotes_example.py
+src/billkit/__init__.py
+src/billkit/_version.py
+src/billkit/client.py
+src/billkit/exceptions.py
+src/billkit/version.py
+src/billkit.egg-info/PKG-INFO
+src/billkit.egg-info/SOURCES.txt
+src/billkit.egg-info/dependency_links.txt
+src/billkit.egg-info/requires.txt
+src/billkit.egg-info/top_level.txt
+src/billkit/api/__init__.py
+src/billkit/api/account.py
+src/billkit/api/customers.py
+src/billkit/api/invoices.py
+src/billkit/api/quotes.py
+src/billkit/models/__init__.py
+src/billkit/models/enums.py
+src/billkit/models/header.py
+src/billkit/models/invoices.py
+src/billkit/models/items.py
+src/billkit/models/sender.py
+src/billkit/utils/__init__.py
+src/billkit/utils/pdf_downloader.py
+tests/conftest.py

billkit-0.1.dev21/src/billkit.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

billkit-0.1.dev21/src/billkit.egg-info/requires.txt

@@ -0,0 +1,9 @@
+httpx>=0.27.0
+pydantic>=2.0
+
+[dev]
+pre-commit>=3.8.0
+pytest>=8.0.0
+ruff>=0.5.0
+black>=24.0.0
+mypy>=1.10

billkit-0.1.dev21/src/billkit.egg-info/top_level.txt

@@ -0,0 +1 @@
+billkit