idi-shipstation-sdk 0.1.0__tar.gz

idi_shipstation_sdk-0.1.0/.devcontainer/devcontainer-lock.json

@@ -0,0 +1,9 @@
+{
+  "features": {
+    "ghcr.io/devcontainers/features/python:1.7.0": {
+      "version": "1.7.0",
+      "resolved": "ghcr.io/devcontainers/features/python@sha256:8452f39db0852420728c9f7503dd94b3fc71aa558b5e7c8f6f9ce6687e494ae3",
+      "integrity": "sha256:8452f39db0852420728c9f7503dd94b3fc71aa558b5e7c8f6f9ce6687e494ae3"
+    }
+  }
+}

idi_shipstation_sdk-0.1.0/.devcontainer/devcontainer.json

@@ -0,0 +1,9 @@
+{
+  "image": "mcr.microsoft.com/devcontainers/universal:2",
+  "features": {
+    "ghcr.io/devcontainers/features/python:1.7.0": {
+      "version": "3.12",
+      "installTools": false
+    }
+  }
+}

idi_shipstation_sdk-0.1.0/.github/dependabot.yaml

@@ -0,0 +1,24 @@
+version: 2
+updates:
+  - package-ecosystem: devcontainers
+    directory: /
+    schedule:
+      interval: monthly
+
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+    groups:
+      ci-dependencies:
+        patterns:
+          - "*"
+
+  - package-ecosystem: uv
+    directory: /
+    schedule:
+      interval: monthly
+    groups:
+      python-dependencies:
+        patterns:
+          - "*"

idi_shipstation_sdk-0.1.0/.github/workflows/dependency-review.yaml

@@ -0,0 +1,20 @@
+name: Dependency Review
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Dependency Review
+        uses: actions/dependency-review-action@ce3cf9537a52e8119d91fd484ab5b8a807627bf8 # v4.6.0
+        with:
+          config-file: impressdesigns/.github/.github/dependency-review-config.yaml@main

idi_shipstation_sdk-0.1.0/.github/workflows/python-ci.yaml

@@ -0,0 +1,60 @@
+name: Python CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  lint-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Setup Python
+        uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0
+        with:
+          python-version: 3.12
+          allow-prereleases: true
+          cache: pip
+          cache-dependency-path: uv.lock
+
+      - name: Set up uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Sync dependencies
+        run: uv sync --all-extras
+
+      - name: Run pre-commit
+        run: uv run pre-commit run --all-files
+
+      - name: Check formatting
+        run: uv run ruff format --check .
+
+      - name: Run Ruff checks
+        run: uv run ruff check --output-format=github .
+
+      - name: Run mypy
+        run: uv run mypy --strict src/
+
+      - name: Run tests
+        run: uv run coverage run -m pytest -v
+
+      - name: Create coverage report
+        run: uv run coverage xml
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@0565863a31f2c772f9f0395002a31e3f06189574 # v5.4.0
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  docs:
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+
+    uses: darbiadev/.github/.github/workflows/github-pages-python-sphinx.yaml@91dda16028f109ac78016dd740206fd109740068 # v15.0.0

idi_shipstation_sdk-0.1.0/.github/workflows/python-publish-pypi.yaml

@@ -0,0 +1,52 @@
+name: Publish Python 🐍 distributions 📦 to PyPI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  release:
+    types:
+      - published
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+    permissions:
+      attestations: write
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Build and inspect Python 🐍 package 📦
+        uses: hynek/build-and-inspect-python-package@b5076c307dc91924a82ad150cdd1533b444d3310 # v2.12.0
+        with:
+          attest-build-provenance-github: ${{ github.event.action == 'published' }}
+
+  publish-to-pypi:
+    name: Publish Python 🐍 distribution 📦 to PyPI
+    needs: build
+    if: ${{ github.event.action == 'published' }}
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/idi-shipstation-sdk/${{ github.ref_name }}
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Download dists
+      uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4.2.1
+      with:
+        name: Packages
+        path: dist/
+
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # v1.12.4
+      with:
+          print-hash: true

idi_shipstation_sdk-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+# Packaging
+*.egg-info
+dist
+
+# Cache
+__pycache__
+
+# Docs
+docs/build

idi_shipstation_sdk-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: check-json
+      - id: trailing-whitespace
+        args: [ --markdown-linebreak-ext=md ]
+      - id: mixed-line-ending
+        args: [ --fix=lf ]
+      - id: end-of-file-fixer
+        exclude: .devcontainer/devcontainer-lock.json
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.6.5
+    hooks:
+      - id: uv-lock

idi_shipstation_sdk-0.1.0/LICENSE

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

idi_shipstation_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: idi-shipstation-sdk
+Version: 0.1.0
+Summary: ShipStation API SDK
+Project-URL: repository, https://github.com/impressdesigns/shipstation-sdk/
+Project-URL: documentation, https://impressdesigns.dev/shipstation-sdk/
+Author-email: Bradley Reynolds <bradley.reynolds@impressdesigns.com>
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: httpx>=0.27.2
+Requires-Dist: pydantic>=2.9.2
+Provides-Extra: docs
+Requires-Dist: furo>=2024.5.6; extra == 'docs'
+Requires-Dist: releases>=2.1.1; extra == 'docs'
+Requires-Dist: sphinx-autoapi>=3.1.2; extra == 'docs'
+Requires-Dist: sphinx>=7.4.4; extra == 'docs'
+Provides-Extra: tests
+Requires-Dist: coverage>=7.6.1; extra == 'tests'
+Requires-Dist: pytest-randomly>=3.15.0; extra == 'tests'
+Requires-Dist: pytest>=8.2.2; extra == 'tests'
+Description-Content-Type: text/markdown
+
+# shipstation-sdk
+
+ShipStation SDK

idi_shipstation_sdk-0.1.0/README.md

@@ -0,0 +1,3 @@
+# shipstation-sdk
+
+ShipStation SDK

idi_shipstation_sdk-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

idi_shipstation_sdk-0.1.0/docs/source/changelog.rst

@@ -0,0 +1,5 @@
+Changelog
+=========
+
+- :release:`0.1.0 <6th May 2025>`
+- :feature:`-` Initial release

idi_shipstation_sdk-0.1.0/docs/source/conf.py

@@ -0,0 +1,93 @@
+"""Configuration file for the Sphinx documentation builder.
+
+For the full list of built-in configuration values, see the documentation:
+https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""
+
+from importlib.metadata import metadata
+
+project_metadata = metadata("idi-shipstation-sdk")
+project: str = project_metadata["Name"]
+release: str = project_metadata["Version"]
+REPO_LINK: str = project_metadata["Project-URL"].replace("repository, ", "")
+copyright: str = "Impress Designs"  # noqa: A001
+author: str = "Impress Designs team"
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named "sphinx.ext.*") or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.linkcode",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "autoapi.extension",
+    "releases",
+]
+
+autoapi_type: str = "python"
+autoapi_dirs: list[str] = ["../../src"]
+
+intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path: list[str] = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns: list[str] = ["_build", "Thumbs.db", ".DS_Store"]
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme: str = "furo"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path: list[str] = ["_static"]
+
+releases_github_path = REPO_LINK.removeprefix("https://github.com/")
+releases_release_uri = f"{REPO_LINK}/releases/tag/v%s"
+
+
+def linkcode_resolve(domain: str, info: dict) -> str | None:
+    """linkcode_resolve."""
+    if domain != "py":
+        return None
+    if not info["module"]:
+        return None
+
+    import importlib
+    import inspect
+    import types
+
+    mod = importlib.import_module(info["module"])
+
+    val = mod
+    for k in info["fullname"].split("."):
+        val = getattr(val, k, None)
+        if val is None:
+            break
+
+    filename = info["module"].replace(".", "/") + ".py"
+
+    if isinstance(
+        val,
+        types.ModuleType
+        | types.MethodType
+        | types.FunctionType
+        | types.TracebackType
+        | types.FrameType
+        | types.CodeType,
+    ):
+        try:
+            lines, first = inspect.getsourcelines(val)
+            last = first + len(lines) - 1
+            filename += f"#L{first}-L{last}"
+        except (OSError, TypeError):
+            pass
+
+    return f"{REPO_LINK}/blob/main/src/{filename}"

idi_shipstation_sdk-0.1.0/docs/source/index.rst

@@ -0,0 +1,25 @@
+idi-shipstation-sdk
+====================
+
+ShipStation API SDK
+
+Module Index
+------------
+
+.. toctree::
+   :maxdepth: 1
+
+   autoapi/index
+
+.. toctree::
+   :caption: Other:
+   :hidden:
+
+   changelog
+
+Extras
+------
+
+* :ref:`genindex`
+* :ref:`search`
+* :doc:`changelog`

idi_shipstation_sdk-0.1.0/noxfile.py

@@ -0,0 +1,52 @@
+"""Noxfile."""
+
+import shutil
+from pathlib import Path
+
+import nox
+
+nox.options.default_venv_backend = "none"
+nox.options.sessions = ["lints"]
+
+
+CLEANABLE_TARGETS = [
+    "./dist",
+    "./build",
+    "./.nox",
+    "./.coverage",
+    "./.coverage.*",
+    "./coverage.json",
+    "./**/.mypy_cache",
+    "./**/.pytest_cache",
+    "./**/__pycache__",
+    "./**/*.pyc",
+    "./**/*.pyo",
+]
+
+
+@nox.session
+def tests(session: nox.Session) -> None:
+    """Run tests."""
+    session.run("pytest")
+
+
+@nox.session
+def lints(session: nox.Session) -> None:
+    """Run lints."""
+    session.run("pre-commit", "run", "--all-files")
+    session.run("ruff", "format", ".")
+    session.run("ruff", "check", "--fix", ".")
+    session.run("mypy", "--strict", "src/")
+
+
+@nox.session
+def clean(_: nox.Session) -> None:
+    """Clean cache, .pyc, .pyo, and test/build artifact files from project."""
+    count = 0
+    for searchpath in CLEANABLE_TARGETS:
+        for filepath in Path().glob(searchpath):
+            if filepath.is_dir():
+                shutil.rmtree(filepath)
+            else:
+                filepath.unlink()
+            count += 1

idi_shipstation_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,74 @@
+[project]
+name = "idi-shipstation-sdk"
+version = "0.1.0"
+description = "ShipStation API SDK"
+authors = [
+    { name = "Bradley Reynolds", email = "bradley.reynolds@impressdesigns.com" },
+]
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.13"
+dependencies = ["pydantic>=2.9.2","httpx>=0.27.2"]
+
+[project.optional-dependencies]
+docs = [
+    "sphinx>=7.4.4",
+    "furo>=2024.5.6",
+    "sphinx-autoapi>=3.1.2",
+    "releases>=2.1.1",
+]
+tests = ["pytest>=8.2.2", "pytest-randomly>=3.15.0", "coverage>=7.6.1"]
+
+[project.urls]
+repository = "https://github.com/impressdesigns/shipstation-sdk/"
+documentation = "https://impressdesigns.dev/shipstation-sdk/"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    # DX
+    "nox>=2024.4.15",
+    "pre-commit>=3.7.1",
+    # Linters
+    "ruff>=0.5.2",
+    "mypy>=1.10.1",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/shipstation_sdk"]
+
+[tool.ruff]
+target-version = "py313"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "CPY001", # (Missing copyright notice at top of file) - No license
+]
+
+[tool.ruff.lint.extend-per-file-ignores]
+"docs/*" = [
+    "INP001", # (File `docs/conf.py` is part of an implicit namespace package. Add an `__init__.py`.) - Docs are not modules
+]
+"tests/*" = [
+    "S101",   # (Use of `assert` detected) - Yes, that's the point
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["shipstation_sdk"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.coverage.run]
+source = ["shipstation_sdk"]
+
+[tool.pytest.ini_options]
+addopts = "--strict-markers"

idi_shipstation_sdk-0.1.0/src/shipstation_sdk/__init__.py

@@ -0,0 +1,5 @@
+"""ShipStation API SDK."""
+
+from .client import ShipStationClient
+
+__all__ = ["ShipStationClient"]

idi_shipstation_sdk-0.1.0/src/shipstation_sdk/client.py

@@ -0,0 +1,62 @@
+"""Interacting with ShipStation."""
+
+from datetime import date
+from typing import Any
+
+from httpx import Client, Response
+
+from .models import ShipmentsResponse
+
+
+class ShipStationClient:
+    """A class wrapping ShipStation interaction."""
+
+    def __init__(
+        self,
+        base_url: str,
+        client_id: str,
+        client_secret: str,
+        timeout: float,
+    ) -> None:
+        """Initialize the ShipStationClient class."""
+        self.client = Client(
+            base_url=base_url,
+            auth=(client_id, client_secret),
+            timeout=timeout,
+        )
+
+    def make_request(
+        self,
+        method: str,
+        path: str,
+        params: dict[str, Any] | None = None,
+        json: dict[str, Any] | None = None,
+    ) -> Response:
+        """Make a request to ShipStation."""
+        args: dict[str, str | dict[str, str]] = {
+            "url": path,
+            "method": method,
+        }
+
+        if params is not None:
+            args["params"] = params
+
+        if json is not None:
+            args["json"] = json
+
+        return self.client.request(**args)  # type: ignore[arg-type]
+
+    def get_shipments(
+        self,
+        ship_date_start: date | None = None,
+        ship_date_end: date | None = None,
+    ) -> ShipmentsResponse:
+        """Get a list of shipments."""
+        params = {}
+        if ship_date_start:
+            params["shipDateStart"] = ship_date_start.isoformat()
+        if ship_date_end:
+            params["shipDateEnd"] = ship_date_end.isoformat()
+        response = self.make_request("GET", "/shipments", params=params)
+        response.raise_for_status()
+        return ShipmentsResponse.model_validate(response.json())