peepstick 0.1.0__tar.gz

peepstick-0.1.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: peepstick
+Version: 0.1.0
+Summary: Drop-in ticket form + Slack routing for Django apps, powered by PeepsTick
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.25
+Provides-Extra: django
+Requires-Dist: django>=4.0; extra == "django"
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.100; extra == "fastapi"
+Requires-Dist: pydantic>=2.0; extra == "fastapi"
+
+# peepstick
+
+Drop this into a Python app to get ticket routing that goes straight to
+your team's Slack channel — configured entirely from the PeepsTick dashboard.
+
+This package never talks to Slack. It only ever calls your PeepsTick
+project's API (`/api/form-schema`, `/api/tickets`). PeepsTick owns the
+Slack webhook and does the actual posting server-side.
+
+## Install
+
+```bash
+# FastAPI apps
+pip install "peepstick[fastapi]"
+
+# Django apps
+pip install "peepstick[django]"
+```
+
+## FastAPI setup
+
+```python
+from fastapi import FastAPI
+from peepstick.fastapi import create_ticket_router
+
+app = FastAPI()
+app.include_router(
+    create_ticket_router(
+        api_key="tk_...",             # from your project's page in the PeepsTick dashboard
+        base_url="https://peepstick.yourcompany.com",
+    ),
+    prefix="/peepstick",
+)
+```
+
+This gives your app two routes your frontend can call — the API key
+never reaches the browser:
+
+- `GET /peepstick/form-schema` — the live fields configured for your project
+- `POST /peepstick/tickets` — submits `{"fields": {...}}`, validated and
+  routed to Slack server-side
+
+Add or rename fields in the PeepsTick dashboard and `/peepstick/form-schema`
+updates automatically — no code changes or redeploys needed.
+
+## Django setup
+
+1. In `settings.py`, add the app and your project's credentials
+   (find the API key on your project's page in the PeepsTick dashboard):
+
+   ```python
+   INSTALLED_APPS = [
+       ...,
+       "peepstick.django",
+   ]
+
+   PEEPSTICK_API_KEY = "tk_..."
+   PEEPSTICK_BASE_URL = "https://peepstick.yourcompany.com"
+   ```
+
+2. In your project's `urls.py`:
+
+   ```python
+   from django.urls import include, path
+
+   urlpatterns = [
+       ...,
+       path("tickets/", include("peepstick.django.urls")),
+   ]
+   ```
+
+3. Visit `/tickets/`. The form renders whatever fields are configured
+   for your project in the PeepsTick dashboard — add or rename fields
+   there and the form updates automatically, no code changes needed.
+
+## Using the client directly
+
+If you'd rather build your own view or call PeepsTick from a script:
+
+```python
+from peepstick import PeepsTickClient
+
+client = PeepsTickClient(api_key="tk_...", base_url="https://peepstick.yourcompany.com")
+
+fields = client.get_form_schema()
+ticket = client.submit_ticket({"title": "Login broken", "priority": "High"})
+```
+
+Both methods raise `peepstick.PeepsTickError` on failure (network
+issues, invalid API key, missing required fields, etc).

peepstick-0.1.0/README.md

@@ -0,0 +1,90 @@
+# peepstick
+
+Drop this into a Python app to get ticket routing that goes straight to
+your team's Slack channel — configured entirely from the PeepsTick dashboard.
+
+This package never talks to Slack. It only ever calls your PeepsTick
+project's API (`/api/form-schema`, `/api/tickets`). PeepsTick owns the
+Slack webhook and does the actual posting server-side.
+
+## Install
+
+```bash
+# FastAPI apps
+pip install "peepstick[fastapi]"
+
+# Django apps
+pip install "peepstick[django]"
+```
+
+## FastAPI setup
+
+```python
+from fastapi import FastAPI
+from peepstick.fastapi import create_ticket_router
+
+app = FastAPI()
+app.include_router(
+    create_ticket_router(
+        api_key="tk_...",             # from your project's page in the PeepsTick dashboard
+        base_url="https://peepstick.yourcompany.com",
+    ),
+    prefix="/peepstick",
+)
+```
+
+This gives your app two routes your frontend can call — the API key
+never reaches the browser:
+
+- `GET /peepstick/form-schema` — the live fields configured for your project
+- `POST /peepstick/tickets` — submits `{"fields": {...}}`, validated and
+  routed to Slack server-side
+
+Add or rename fields in the PeepsTick dashboard and `/peepstick/form-schema`
+updates automatically — no code changes or redeploys needed.
+
+## Django setup
+
+1. In `settings.py`, add the app and your project's credentials
+   (find the API key on your project's page in the PeepsTick dashboard):
+
+   ```python
+   INSTALLED_APPS = [
+       ...,
+       "peepstick.django",
+   ]
+
+   PEEPSTICK_API_KEY = "tk_..."
+   PEEPSTICK_BASE_URL = "https://peepstick.yourcompany.com"
+   ```
+
+2. In your project's `urls.py`:
+
+   ```python
+   from django.urls import include, path
+
+   urlpatterns = [
+       ...,
+       path("tickets/", include("peepstick.django.urls")),
+   ]
+   ```
+
+3. Visit `/tickets/`. The form renders whatever fields are configured
+   for your project in the PeepsTick dashboard — add or rename fields
+   there and the form updates automatically, no code changes needed.
+
+## Using the client directly
+
+If you'd rather build your own view or call PeepsTick from a script:
+
+```python
+from peepstick import PeepsTickClient
+
+client = PeepsTickClient(api_key="tk_...", base_url="https://peepstick.yourcompany.com")
+
+fields = client.get_form_schema()
+ticket = client.submit_ticket({"title": "Login broken", "priority": "High"})
+```
+
+Both methods raise `peepstick.PeepsTickError` on failure (network
+issues, invalid API key, missing required fields, etc).

peepstick-0.1.0/peepstick/__init__.py

@@ -0,0 +1,4 @@
+from .client import PeepsTickClient, PeepsTickError
+
+__all__ = ["PeepsTickClient", "PeepsTickError"]
+__version__ = "0.1.0"

peepstick-0.1.0/peepstick/client.py

@@ -0,0 +1,60 @@
+"""Thin HTTP client for the PeepsTick ticket-routing API.
+
+This is the only file in the package that talks to the network. It never
+talks to Slack — it only ever calls your PeepsTick dashboard's API, which is
+the piece that owns the Slack webhook and does the actual posting.
+"""
+import requests
+
+DEFAULT_TIMEOUT = 5
+
+
+class PeepsTickError(Exception):
+    """Raised when the PeepsTick API returns an error or can't be reached."""
+
+
+class PeepsTickClient:
+    """Talks to a single PeepsTick project, identified by its API key."""
+
+    def __init__(self, api_key: str, base_url: str, timeout: int = DEFAULT_TIMEOUT):
+        if not api_key:
+            raise ValueError("PeepsTick api_key is required")
+        if not base_url:
+            raise ValueError("PeepsTick base_url is required")
+        self.api_key = api_key
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+
+    def get_form_schema(self):
+        """Fetches the live form schema configured for this project."""
+        url = f"{self.base_url}/api/form-schema"
+        resp = self._request("get", url)
+        return self._parse(resp).get("formSchema", [])
+
+    def submit_ticket(self, fields: dict):
+        """Submits ticket field values. PeepsTick validates, stores, and
+        relays to Slack server-side — this call never sees the webhook."""
+        url = f"{self.base_url}/api/tickets"
+        resp = self._request("post", url, json={"fields": fields})
+        return self._parse(resp).get("ticket")
+
+    def _request(self, method: str, url: str, **kwargs):
+        try:
+            return requests.request(
+                method, url, headers=self._headers(), timeout=self.timeout, **kwargs
+            )
+        except requests.RequestException as exc:
+            raise PeepsTickError(f"Could not reach PeepsTick at {url}: {exc}") from exc
+
+    def _headers(self):
+        return {"x-api-key": self.api_key, "Content-Type": "application/json"}
+
+    @staticmethod
+    def _parse(resp):
+        try:
+            data = resp.json()
+        except ValueError:
+            data = {}
+        if resp.status_code >= 400:
+            raise PeepsTickError(data.get("error", f"PeepsTick API error ({resp.status_code})"))
+        return data

peepstick-0.1.0/peepstick/django/__init__.py

@@ -0,0 +1 @@
+default_app_config = "peepstick.django.apps.PeepsTickConfig"

peepstick-0.1.0/peepstick/django/apps.py

@@ -0,0 +1,8 @@
+from django.apps import AppConfig
+
+
+class PeepsTickConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "peepstick.django"
+    label = "peepstick_django"
+    verbose_name = "PeepsTick Tickets"

peepstick-0.1.0/peepstick/django/templates/peepstick/error.html

@@ -0,0 +1,8 @@
+<!doctype html>
+<html>
+<head><meta charset="utf-8"><title>Ticket form unavailable</title></head>
+<body>
+  <h1>Ticket form unavailable</h1>
+  <p>{{ error }}</p>
+</body>
+</html>

peepstick-0.1.0/peepstick/django/templates/peepstick/ticket_form.html

@@ -0,0 +1,36 @@
+<!doctype html>
+<html>
+<head><meta charset="utf-8"><title>Submit a ticket</title></head>
+<body>
+  <h1>Submit a ticket</h1>
+  <form method="post" action="{% url 'peepstick:submit_ticket' %}">
+    {% csrf_token %}
+    {% for field in fields %}
+      <div class="peepstick-field">
+        <label for="{{ field.id }}">
+          {{ field.label }}{% if field.required %} *{% endif %}
+        </label>
+
+        {% if field.type == "textarea" %}
+          <textarea id="{{ field.id }}" name="{{ field.id }}"
+            {% if field.required %}required{% endif %}></textarea>
+
+        {% elif field.options %}
+          <select id="{{ field.id }}" name="{{ field.id }}"
+            {% if field.required %}required{% endif %}>
+            <option value="">Select…</option>
+            {% for option in field.options %}
+              <option value="{{ option }}">{{ option }}</option>
+            {% endfor %}
+          </select>
+
+        {% else %}
+          <input type="text" id="{{ field.id }}" name="{{ field.id }}"
+            {% if field.required %}required{% endif %}>
+        {% endif %}
+      </div>
+    {% endfor %}
+    <button type="submit">Submit</button>
+  </form>
+</body>
+</html>

peepstick-0.1.0/peepstick/django/urls.py

@@ -0,0 +1,10 @@
+from django.urls import path
+
+from . import views
+
+app_name = "peepstick"
+
+urlpatterns = [
+    path("", views.ticket_form, name="ticket_form"),
+    path("submit/", views.submit_ticket, name="submit_ticket"),
+]

peepstick-0.1.0/peepstick/django/views.py

@@ -0,0 +1,60 @@
+import json
+
+from django.conf import settings
+from django.http import JsonResponse
+from django.shortcuts import render
+from django.views.decorators.csrf import csrf_exempt
+from django.views.decorators.http import require_http_methods
+
+from ..client import PeepsTickClient, PeepsTickError
+
+
+def _client():
+    """Builds a PeepsTickClient from Django settings.
+
+    Add to settings.py:
+        PEEPSTICK_API_KEY = "tk_..."   # from your PeepsTick project's dashboard
+        PEEPSTICK_BASE_URL = "https://peepstick.yourcompany.com"
+    """
+    api_key = getattr(settings, "PEEPSTICK_API_KEY", None)
+    base_url = getattr(settings, "PEEPSTICK_BASE_URL", None)
+    if not api_key or not base_url:
+        raise PeepsTickError(
+            "PEEPSTICK_API_KEY and PEEPSTICK_BASE_URL must be set in Django settings"
+        )
+    return PeepsTickClient(api_key=api_key, base_url=base_url)
+
+
+def ticket_form(request):
+    """Renders an HTML ticket form built from the project's live schema.
+
+    The schema (which fields exist, which are required) lives in the
+    PeepsTick dashboard, not in this package — this view just fetches
+    whatever the project owner configured and renders it.
+    """
+    try:
+        fields = _client().get_form_schema()
+    except PeepsTickError as exc:
+        return render(request, "peepstick/error.html", {"error": str(exc)}, status=502)
+    return render(request, "peepstick/ticket_form.html", {"fields": fields})
+
+
+@csrf_exempt
+@require_http_methods(["POST"])
+def submit_ticket(request):
+    """Accepts a ticket submission (form-encoded or JSON) and relays it
+    to PeepsTick's /api/tickets endpoint. PeepsTick validates it against the
+    project's schema, stores it, and posts to Slack server-side."""
+    if request.content_type == "application/json":
+        try:
+            fields = json.loads(request.body or "{}")
+        except json.JSONDecodeError:
+            return JsonResponse({"error": "Invalid JSON body"}, status=400)
+    else:
+        fields = request.POST.dict()
+
+    try:
+        ticket = _client().submit_ticket(fields)
+    except PeepsTickError as exc:
+        return JsonResponse({"error": str(exc)}, status=502)
+    return JsonResponse({"ticket": ticket}, status=201)

peepstick-0.1.0/peepstick/fastapi.py

@@ -0,0 +1,58 @@
+"""FastAPI integration for PeepsTick.
+
+Mounts two routes on your own app so the browser only ever talks to your
+server, never to PeepsTick directly — the API key stays server-side.
+
+    from fastapi import FastAPI
+    from peepstick.fastapi import create_ticket_router
+
+    app = FastAPI()
+    app.include_router(
+        create_ticket_router(api_key="tk_...", base_url="https://peepstick.yourcompany.com"),
+        prefix="/peepstick",
+    )
+
+This gives your app:
+    GET  /peepstick/form-schema  — proxies PeepsTick's live form schema
+    POST /peepstick/tickets      — proxies a submission to PeepsTick
+
+Requires FastAPI to be installed in your app already; it's not a
+dependency of this package so you're never forced onto a version you
+didn't choose.
+"""
+from typing import Any, Dict
+
+from .client import PeepsTickClient, PeepsTickError
+
+
+def create_ticket_router(api_key: str, base_url: str, timeout: int = 5):
+    try:
+        from fastapi import APIRouter, HTTPException
+        from pydantic import BaseModel
+    except ImportError as exc:
+        raise ImportError(
+            "peepstick.fastapi requires fastapi and pydantic to be installed "
+            "in your app (pip install fastapi)"
+        ) from exc
+
+    client = PeepsTickClient(api_key=api_key, base_url=base_url, timeout=timeout)
+    router = APIRouter()
+
+    class TicketSubmission(BaseModel):
+        fields: Dict[str, Any]
+
+    @router.get("/form-schema")
+    def get_form_schema():
+        try:
+            return {"formSchema": client.get_form_schema()}
+        except PeepsTickError as exc:
+            raise HTTPException(status_code=502, detail=str(exc)) from exc
+
+    @router.post("/tickets", status_code=201)
+    def submit_ticket(submission: TicketSubmission):
+        try:
+            return {"ticket": client.submit_ticket(submission.fields)}
+        except PeepsTickError as exc:
+            raise HTTPException(status_code=502, detail=str(exc)) from exc
+
+    return router

peepstick-0.1.0/peepstick.egg-info/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: peepstick
+Version: 0.1.0
+Summary: Drop-in ticket form + Slack routing for Django apps, powered by PeepsTick
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.25
+Provides-Extra: django
+Requires-Dist: django>=4.0; extra == "django"
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.100; extra == "fastapi"
+Requires-Dist: pydantic>=2.0; extra == "fastapi"
+
+# peepstick
+
+Drop this into a Python app to get ticket routing that goes straight to
+your team's Slack channel — configured entirely from the PeepsTick dashboard.
+
+This package never talks to Slack. It only ever calls your PeepsTick
+project's API (`/api/form-schema`, `/api/tickets`). PeepsTick owns the
+Slack webhook and does the actual posting server-side.
+
+## Install
+
+```bash
+# FastAPI apps
+pip install "peepstick[fastapi]"
+
+# Django apps
+pip install "peepstick[django]"
+```
+
+## FastAPI setup
+
+```python
+from fastapi import FastAPI
+from peepstick.fastapi import create_ticket_router
+
+app = FastAPI()
+app.include_router(
+    create_ticket_router(
+        api_key="tk_...",             # from your project's page in the PeepsTick dashboard
+        base_url="https://peepstick.yourcompany.com",
+    ),
+    prefix="/peepstick",
+)
+```
+
+This gives your app two routes your frontend can call — the API key
+never reaches the browser:
+
+- `GET /peepstick/form-schema` — the live fields configured for your project
+- `POST /peepstick/tickets` — submits `{"fields": {...}}`, validated and
+  routed to Slack server-side
+
+Add or rename fields in the PeepsTick dashboard and `/peepstick/form-schema`
+updates automatically — no code changes or redeploys needed.
+
+## Django setup
+
+1. In `settings.py`, add the app and your project's credentials
+   (find the API key on your project's page in the PeepsTick dashboard):
+
+   ```python
+   INSTALLED_APPS = [
+       ...,
+       "peepstick.django",
+   ]
+
+   PEEPSTICK_API_KEY = "tk_..."
+   PEEPSTICK_BASE_URL = "https://peepstick.yourcompany.com"
+   ```
+
+2. In your project's `urls.py`:
+
+   ```python
+   from django.urls import include, path
+
+   urlpatterns = [
+       ...,
+       path("tickets/", include("peepstick.django.urls")),
+   ]
+   ```
+
+3. Visit `/tickets/`. The form renders whatever fields are configured
+   for your project in the PeepsTick dashboard — add or rename fields
+   there and the form updates automatically, no code changes needed.
+
+## Using the client directly
+
+If you'd rather build your own view or call PeepsTick from a script:
+
+```python
+from peepstick import PeepsTickClient
+
+client = PeepsTickClient(api_key="tk_...", base_url="https://peepstick.yourcompany.com")
+
+fields = client.get_form_schema()
+ticket = client.submit_ticket({"title": "Login broken", "priority": "High"})
+```
+
+Both methods raise `peepstick.PeepsTickError` on failure (network
+issues, invalid API key, missing required fields, etc).

peepstick-0.1.0/peepstick.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+README.md
+pyproject.toml
+peepstick/__init__.py
+peepstick/client.py
+peepstick/fastapi.py
+peepstick.egg-info/PKG-INFO
+peepstick.egg-info/SOURCES.txt
+peepstick.egg-info/dependency_links.txt
+peepstick.egg-info/requires.txt
+peepstick.egg-info/top_level.txt
+peepstick/django/__init__.py
+peepstick/django/apps.py
+peepstick/django/urls.py
+peepstick/django/views.py
+peepstick/django/templates/peepstick/error.html
+peepstick/django/templates/peepstick/ticket_form.html

peepstick-0.1.0/peepstick.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

peepstick-0.1.0/peepstick.egg-info/requires.txt

@@ -0,0 +1,8 @@
+requests>=2.25
+
+[django]
+django>=4.0
+
+[fastapi]
+fastapi>=0.100
+pydantic>=2.0

peepstick-0.1.0/peepstick.egg-info/top_level.txt

@@ -0,0 +1 @@
+peepstick

peepstick-0.1.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "peepstick"
+version = "0.1.0"
+description = "Drop-in ticket form + Slack routing for Django apps, powered by PeepsTick"
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = ["requests>=2.25"]
+
+[project.optional-dependencies]
+django = ["django>=4.0"]
+fastapi = ["fastapi>=0.100", "pydantic>=2.0"]
+
+[tool.setuptools.packages.find]
+include = ["peepstick*"]
+
+[tool.setuptools.package-data]
+"peepstick.django" = ["templates/peepstick/*.html"]

peepstick-0.1.0/setup.cfg

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