stackin-python-sdk 0.1.0__tar.gz → 0.1.1__tar.gz

{stackin_python_sdk-0.1.0 → stackin_python_sdk-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stackin-python-sdk
-Version: 0.1.0
+Version: 0.1.1
 Summary: Python SDK for issuing, consulting and cancelling electronic invoices.
 License-Expression: MIT
 License-File: LICENSE
@@ -20,6 +20,11 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Natural Language :: Portuguese (Brazilian)
 Requires-Dist: pydantic
 Requires-Dist: requests
+Project-URL: Changelog, https://github.com/stackin-io/stackin-python-sdk/releases
+Project-URL: Documentation, https://docs.stackin.io/blog/python-sdk
+Project-URL: Homepage, https://docs.stackin.io
+Project-URL: Issues, https://github.com/stackin-io/stackin-python-sdk/issues
+Project-URL: Repository, https://github.com/stackin-io/stackin-python-sdk
 Description-Content-Type: text/markdown
 
 <div align="center">
@@ -29,8 +34,11 @@ Description-Content-Type: text/markdown
 **Integrate once. Issue everywhere.**
 
 [![Python](https://img.shields.io/badge/python-3.10%2B-blue?style=flat-square)](pyproject.toml)
+[![PyPI](https://img.shields.io/pypi/v/stackin-python-sdk?style=flat-square)](https://pypi.org/project/stackin-python-sdk/)
 [![License](https://img.shields.io/badge/license-MIT-informational?style=flat-square)](https://github.com/stackin-io/stackin-python-sdk)
 
+[API Reference](https://docs.stackin.io) · [Python SDK guide](https://docs.stackin.io/blog/python-sdk)
+
 </div>
 
 ---
@@ -49,7 +57,7 @@ pip install stackin-python-sdk
 
 ## Usage
 
-Get an `api_key` from the [stackin dashboard](https://app.stackin.io) — select the issuing company, then Settings → API key. One key per issuing company, shown once at creation. The API resolves the issuer (CNPJ, state, address, certificate, environment) entirely from it; nothing about the issuer is ever passed on a call.
+Get an `api_key` from the [stackin dashboard](https://app.stackin.io) — select the issuing company, then Settings → API key (context `sdk`). One key per issuing company, shown once at creation. The API resolves the issuer (CNPJ, state, address, certificate, environment) entirely from it; nothing about the issuer is ever passed on a call.
 
 ```python
 from stackin import Invoice, DocumentType, Address
@@ -98,17 +106,3 @@ Building the full fiscal document (issuer data, service code, tax groups, schema
 
 Runnable end-to-end scripts in [`examples/`](examples/) — `simple_issue_nfe.py` and `simple_issue_nfse.py`, each with a catalog of realistic line items covering every optional field.
 
-## Commit Style
-
-| Icon | Type      | Description                                |
-|------|-----------|--------------------------------------------|
-| ⚙️   | FEATURE   | New feature                                |
-| 📝   | PEP8      | Formatting fixes following PEP8            |
-| 📌   | ISSUE     | Reference to issue                         |
-| 🪲   | BUG       | Bug fix                                    |
-| 📘   | DOCS      | Documentation changes                      |
-| 📦   | PyPI      | PyPI releases                              |
-| ❤️️   | TEST      | Automated tests                            |
-| ⬆️   | CI/CD     | Changes in continuous integration/delivery |
-| ⚠️   | SECURITY  | Security improvements                      |
-

{stackin_python_sdk-0.1.0 → stackin_python_sdk-0.1.1}/README.md

@@ -5,8 +5,11 @@
 **Integrate once. Issue everywhere.**
 
 [![Python](https://img.shields.io/badge/python-3.10%2B-blue?style=flat-square)](pyproject.toml)
+[![PyPI](https://img.shields.io/pypi/v/stackin-python-sdk?style=flat-square)](https://pypi.org/project/stackin-python-sdk/)
 [![License](https://img.shields.io/badge/license-MIT-informational?style=flat-square)](https://github.com/stackin-io/stackin-python-sdk)
 
+[API Reference](https://docs.stackin.io) · [Python SDK guide](https://docs.stackin.io/blog/python-sdk)
+
 </div>
 
 ---
@@ -25,7 +28,7 @@ pip install stackin-python-sdk
 
 ## Usage
 
-Get an `api_key` from the [stackin dashboard](https://app.stackin.io) — select the issuing company, then Settings → API key. One key per issuing company, shown once at creation. The API resolves the issuer (CNPJ, state, address, certificate, environment) entirely from it; nothing about the issuer is ever passed on a call.
+Get an `api_key` from the [stackin dashboard](https://app.stackin.io) — select the issuing company, then Settings → API key (context `sdk`). One key per issuing company, shown once at creation. The API resolves the issuer (CNPJ, state, address, certificate, environment) entirely from it; nothing about the issuer is ever passed on a call.
 
 ```python
 from stackin import Invoice, DocumentType, Address
@@ -73,17 +76,3 @@ Building the full fiscal document (issuer data, service code, tax groups, schema
 ## Examples
 
 Runnable end-to-end scripts in [`examples/`](examples/) — `simple_issue_nfe.py` and `simple_issue_nfse.py`, each with a catalog of realistic line items covering every optional field.
-
-## Commit Style
-
-| Icon | Type      | Description                                |
-|------|-----------|--------------------------------------------|
-| ⚙️   | FEATURE   | New feature                                |
-| 📝   | PEP8      | Formatting fixes following PEP8            |
-| 📌   | ISSUE     | Reference to issue                         |
-| 🪲   | BUG       | Bug fix                                    |
-| 📘   | DOCS      | Documentation changes                      |
-| 📦   | PyPI      | PyPI releases                              |
-| ❤️️   | TEST      | Automated tests                            |
-| ⬆️   | CI/CD     | Changes in continuous integration/delivery |
-| ⚠️   | SECURITY  | Security improvements                      |

{stackin_python_sdk-0.1.0 → stackin_python_sdk-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "stackin-python-sdk"
-version = "0.1.0"
+version = "0.1.1"
 authors = [
   { name = "Fernando Celmer", email = "email@fernandocelmer.com" },
 ]
@@ -36,9 +36,16 @@ dependencies = [
   "pydantic",
 ]
 
+[project.urls]
+Homepage = "https://docs.stackin.io"
+Documentation = "https://docs.stackin.io/blog/python-sdk"
+Repository = "https://github.com/stackin-io/stackin-python-sdk"
+Issues = "https://github.com/stackin-io/stackin-python-sdk/issues"
+Changelog = "https://github.com/stackin-io/stackin-python-sdk/releases"
+
 [tool.poetry]
 name = "stackin-python-sdk"
-version = "0.1.0"
+version = "0.1.1"
 description = "Python SDK for issuing, consulting and cancelling electronic invoices."
 authors = ["Fernando Celmer <email@fernandocelmer.com>"]
 readme = "README.md"

{stackin_python_sdk-0.1.0 → stackin_python_sdk-0.1.1}/stackin/__init__.py

@@ -1,6 +1,6 @@
 """Invoice __init__ module."""
 
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 __description__ = (
     "Python SDK for issuing, consulting and cancelling electronic invoices."
 )

{stackin_python_sdk-0.1.0 → stackin_python_sdk-0.1.1}/stackin/br/product.py

@@ -55,11 +55,13 @@ class Product(BaseModel):
     ncm: str | None = Field(default=None, pattern=r"^\d{2}$|^\d{8}$")
     cfop: str | None = Field(default=None, pattern=r"^[123567]\d{3}$")
     cest: str | None = Field(default=None, pattern=r"^\d{7}$")
-    nve_codes: list[Annotated[str, Field(pattern=r"^[A-Z]{2}\d{4}$")]] | None = Field(
-        default=None
-    )
+    nve_codes: (
+        list[Annotated[str, Field(pattern=r"^[A-Z]{2}\d{4}$")]] | None
+    ) = Field(default=None)
     ind_escala: str | None = Field(default=None)
-    manufacturer_cnpj: str | None = Field(default=None, pattern=r"^[0-9A-Z]{12}\d{2}$")
+    manufacturer_cnpj: str | None = Field(
+        default=None, pattern=r"^[0-9A-Z]{12}\d{2}$"
+    )
     tax_benefit_code: str | None = Field(default=None, pattern=_CBENEF_PATTERN)
     presumed_credits: list[PresumedCredit] | None = Field(default=None)
     ex_tipi: str | None = Field(default=None, pattern=r"^\d{2,3}$")
@@ -84,4 +86,8 @@ class Product(BaseModel):
             br["tax"] = self.tax
         if br:
             data["br"] = br
-        return {"description": self.description, "amount": self.amount, "product": data}
+        return {
+            "description": self.description,
+            "amount": self.amount,
+            "product": data,
+        }

{stackin_python_sdk-0.1.0 → stackin_python_sdk-0.1.1}/stackin/br/tax.py

@@ -44,7 +44,9 @@ class Icms60(BaseModel):
     cst: str = Field(default="60", alias="CST")
     v_bc_st_ret: str | None = Field(default=None, alias="vBCSTRet")
     p_st: str | None = Field(default=None, alias="pST")
-    v_icms_substituto: str | None = Field(default=None, alias="vICMSSubstituto")
+    v_icms_substituto: str | None = Field(
+        default=None, alias="vICMSSubstituto"
+    )
     v_icms_st_ret: str | None = Field(default=None, alias="vICMSSTRet")
     v_bc_fcp_st_ret: str | None = Field(default=None, alias="vBCFCPSTRet")
     p_fcp_st_ret: str | None = Field(default=None, alias="pFCPSTRet")
@@ -234,7 +236,9 @@ class Tax(BaseModel):
                 by_alias=True, exclude_none=True
             )
         if self.ipi is not None:
-            data["IPI"] = self.ipi.to_dict() if isinstance(self.ipi, Ipi) else self.ipi
+            data["IPI"] = (
+                self.ipi.to_dict() if isinstance(self.ipi, Ipi) else self.ipi
+            )
         if self.pis is not None:
             data["PIS"] = _wrap(self.pis, _PIS_TAGS)
         if self.cofins is not None:
@@ -246,4 +250,6 @@ def _wrap(group: BaseModel | dict, tags: dict[type, str]) -> dict:
     """Nests a tax group under its variant name."""
     if isinstance(group, dict):
         return group
-    return {tags[type(group)]: group.model_dump(by_alias=True, exclude_none=True)}
+    return {
+        tags[type(group)]: group.model_dump(by_alias=True, exclude_none=True)
+    }

{stackin_python_sdk-0.1.0 → stackin_python_sdk-0.1.1}/stackin/core/client.py

@@ -6,8 +6,8 @@ import os
 
 import requests
 
-from stackin.core.address import Address
 from stackin.br.product import Product
+from stackin.core.address import Address
 from stackin.core.exceptions import APIError, ConnectionFailedError
 from stackin.core.types import DocumentType, Environment
 
@@ -71,7 +71,9 @@ class Invoice:
                 if not item.ncm:
                     raise ValueError(f"items[{index}].ncm is required for NFE")
                 if not item.cfop:
-                    raise ValueError(f"items[{index}].cfop is required for NFE")
+                    raise ValueError(
+                        f"items[{index}].cfop is required for NFE"
+                    )
 
         payload = {
             "document_type": document_type.value,
@@ -108,7 +110,9 @@ class Invoice:
             "reason": reason,
         }
 
-        return self._request("POST", f"/invoices/{access_key}/cancel", json=payload)
+        return self._request(
+            "POST", f"/invoices/{access_key}/cancel", json=payload
+        )
 
     def _headers(self) -> dict:
         if self.api_key: