lansweeper-helpdesk 0.1.0__tar.gz

lansweeper_helpdesk-0.1.0/.gitignore

@@ -0,0 +1,40 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Type checking / linting caches
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+
+# Coverage
+htmlcov/
+.coverage
+.coverage.*
+coverage.xml
+
+# Environment / secrets
+.env
+config/config.json
+
+# OS
+.DS_Store
+Thumbs.db

lansweeper_helpdesk-0.1.0/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/).
+
+## [0.1.0] - 2026-03-05
+
+Initial release as a proper Python package.
+
+### Added
+
+- Installable package via `pip install lansweeper-helpdesk`.
+- Full type annotations on all public methods and parameters.
+- Custom exception hierarchy: `HelpdeskError`, `APIError`, `ConfigurationError`, `TicketNotFoundError`.
+- `TicketState` and `NoteType` enums for common API values.
+- `py.typed` marker for PEP 561 type checker support.
+- Comprehensive test suite using pytest and responses.
+- CI pipeline (GitHub Actions) with testing across Python 3.10–3.13, ruff linting, and mypy type checking.
+- PyPI publishing workflow via GitHub Releases using trusted publishers (OIDC).
+
+### Changed
+
+- **BREAKING**: Renamed `type` parameter to `note_type` in `add_note()` and `ticket_type` in `edit_ticket()` to avoid shadowing the Python builtin.
+- **BREAKING**: Renamed `search_ticket()` to `search_tickets()` with snake_case parameters (`from_user_id`, `agent_id`, `ticket_type`, `max_results`, `min_date`, `max_date`). All parameters are now keyword-only.
+- **BREAKING**: API errors now raise `APIError` instead of returning `None`.
+- **BREAKING**: `get_ticket_history()` now returns a `list[dict]` of parsed notes instead of a formatted JSON string.
+- Replaced all `print()` calls with `logging` — the SDK no longer writes to stdout.
+- `cert_path` is now optional (defaults to standard certificate verification).
+- Internal request method renamed from `make_request` to `_request`.
+
+### Removed
+
+- `pretty_print_response()` — libraries should not print to stdout; use `json.dumps(response, indent=2)` if needed.
+- `usage_decorator` — replaced by proper type annotations and exception handling.
+- Hard-coded `time.sleep(1)` in `get_ticket_history()`.

lansweeper_helpdesk-0.1.0/LICENSE

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

lansweeper_helpdesk-0.1.0/PKG-INFO

@@ -0,0 +1,260 @@
+Metadata-Version: 2.4
+Name: lansweeper-helpdesk
+Version: 0.1.0
+Summary: Python SDK for the Lansweeper Helpdesk API — create, search, and manage helpdesk tickets programmatically.
+Project-URL: Homepage, https://github.com/ds-brandao/Lansweeper.Helpdesk-Python
+Project-URL: Documentation, https://github.com/ds-brandao/Lansweeper.Helpdesk-Python#readme
+Project-URL: Repository, https://github.com/ds-brandao/Lansweeper.Helpdesk-Python
+Project-URL: Issues, https://github.com/ds-brandao/Lansweeper.Helpdesk-Python/issues
+Project-URL: Changelog, https://github.com/ds-brandao/Lansweeper.Helpdesk-Python/blob/main/CHANGELOG.md
+Author: Daniel Brandao
+License: MIT
+License-File: LICENSE
+Keywords: api,helpdesk,it-service-management,itsm,lansweeper,sdk,ticketing
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Systems Administration
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: beautifulsoup4>=4.12
+Requires-Dist: requests>=2.28
+Provides-Extra: dev
+Requires-Dist: build>=1.0; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: responses>=0.23; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Requires-Dist: types-beautifulsoup4>=4.12; extra == 'dev'
+Requires-Dist: types-requests>=2.31; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# lansweeper-helpdesk
+
+[![CI](https://github.com/ds-brandao/Lansweeper.Helpdesk-Python/actions/workflows/ci.yml/badge.svg)](https://github.com/ds-brandao/Lansweeper.Helpdesk-Python/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/lansweeper-helpdesk)](https://pypi.org/project/lansweeper-helpdesk/)
+[![Python](https://img.shields.io/pypi/pyversions/lansweeper-helpdesk)](https://pypi.org/project/lansweeper-helpdesk/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A Python SDK for the [Lansweeper Helpdesk API](https://www.lansweeper.com/). Create, retrieve, search, and manage helpdesk tickets programmatically.
+
+> **Note:** The Lansweeper Helpdesk API appears to be unmaintained and may be deprecated in the future. This SDK wraps the existing API as-is.
+
+## Installation
+
+```bash
+pip install lansweeper-helpdesk
+```
+
+## Quick Start
+
+```python
+from lansweeper_helpdesk import HelpdeskAPI
+
+api = HelpdeskAPI(
+    base_url="https://your-helpdesk-url:443/api.aspx",
+    api_key="your-api-key",
+    cert_path="/path/to/cert.pem",  # optional
+)
+
+# Create a ticket
+ticket = api.create_ticket(
+    subject="Network Issue",
+    description="Cannot reach internal network",
+    email="user@example.com",
+)
+
+# Get ticket details (HTML is auto-stripped)
+ticket = api.get_ticket("12345")
+print(ticket["Description"])
+```
+
+## API Reference
+
+### `HelpdeskAPI(base_url, api_key, cert_path=None)`
+
+Initialize the client.
+
+| Parameter   | Type            | Description                                        |
+|-------------|-----------------|----------------------------------------------------|
+| `base_url`  | `str`           | Base URL of the Lansweeper Helpdesk API             |
+| `api_key`   | `str`           | API key for authentication                          |
+| `cert_path` | `str` or `None` | Path to SSL certificate file (optional)             |
+
+### Ticket Operations
+
+#### `create_ticket(subject, description, email) -> dict`
+
+Create a new helpdesk ticket.
+
+```python
+api.create_ticket(
+    subject="Printer not working",
+    description="Office printer on floor 3 is offline",
+    email="user@company.com",
+)
+```
+
+#### `get_ticket(ticket_id) -> dict`
+
+Retrieve ticket details. HTML in the `Description` field is automatically converted to plain text.
+
+```python
+ticket = api.get_ticket("12345")
+```
+
+#### `get_ticket_history(ticket_id) -> list[dict]`
+
+Get all notes for a ticket. HTML content in note text fields is auto-stripped.
+
+```python
+notes = api.get_ticket_history("12345")
+for note in notes:
+    print(note["Text"])
+```
+
+#### `edit_ticket(ticket_id, state, ticket_type, email) -> dict`
+
+Update a ticket's state and type.
+
+```python
+api.edit_ticket(
+    ticket_id="12345",
+    state="Closed",
+    ticket_type="Hardware Repair",
+    email="agent@company.com",
+)
+```
+
+### Notes
+
+#### `add_note(ticket_id, text, email, note_type="Public") -> dict`
+
+Add a note to a ticket. Use `note_type="Internal"` for agent-only notes.
+
+```python
+api.add_note(
+    ticket_id="12345",
+    text="Router restart resolved the issue",
+    email="agent@company.com",
+    note_type="Internal",
+)
+```
+
+### Search
+
+#### `search_tickets(*, state, from_user_id, agent_id, description, subject, ticket_type, max_results, min_date, max_date) -> dict`
+
+Search tickets with optional filters. All parameters are keyword-only and optional.
+
+```python
+results = api.search_tickets(
+    state="Open",
+    ticket_type="Hardware Repair",
+    max_results=50,
+    min_date="2024-01-01",
+    max_date="2024-12-31",
+)
+```
+
+#### `get_user(email) -> dict`
+
+Look up a user by email address.
+
+```python
+user = api.get_user("user@company.com")
+```
+
+### Enums
+
+The SDK provides convenience enums for common values:
+
+```python
+from lansweeper_helpdesk import TicketState, NoteType
+
+api.search_tickets(state=TicketState.OPEN)
+api.add_note("12345", "note text", "a@b.com", note_type=NoteType.INTERNAL)
+```
+
+### Error Handling
+
+All API methods raise typed exceptions instead of returning `None`:
+
+```python
+from lansweeper_helpdesk import HelpdeskAPI, APIError, ConfigurationError
+
+try:
+    api = HelpdeskAPI(base_url="", api_key="key")
+except ConfigurationError as e:
+    print(f"Bad config: {e}")
+
+try:
+    ticket = api.get_ticket("99999")
+except APIError as e:
+    print(f"API error (HTTP {e.status_code}): {e}")
+```
+
+| Exception              | When                                              |
+|------------------------|----------------------------------------------------|
+| `HelpdeskError`        | Base class for all SDK exceptions                  |
+| `ConfigurationError`   | Invalid client configuration                       |
+| `APIError`             | HTTP or API-level error (has `.status_code`)       |
+| `TicketNotFoundError`  | Requested ticket does not exist                    |
+
+## Configuration
+
+You can load credentials from a JSON config file:
+
+```python
+import json
+from lansweeper_helpdesk import HelpdeskAPI
+
+with open("config/config.json") as f:
+    config = json.load(f)
+
+api = HelpdeskAPI(**config)
+```
+
+Example `config/config.json`:
+
+```json
+{
+    "base_url": "https://your-helpdesk-url:443/api.aspx",
+    "api_key": "your-api-key-here",
+    "cert_path": "path/to/your/certificate.pem"
+}
+```
+
+## Development
+
+```bash
+# Clone and install in dev mode
+git clone https://github.com/ds-brandao/Lansweeper.Helpdesk-Python.git
+cd Lansweeper.Helpdesk-Python
+pip install -e ".[dev]"
+
+# Run tests
+pytest --cov
+
+# Lint & format
+ruff check src/ tests/
+ruff format src/ tests/
+
+# Type check
+mypy src/
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for full guidelines.
+
+## License
+
+MIT License — see [LICENSE](LICENSE) for details.

lansweeper_helpdesk-0.1.0/README.md

@@ -0,0 +1,220 @@
+# lansweeper-helpdesk
+
+[![CI](https://github.com/ds-brandao/Lansweeper.Helpdesk-Python/actions/workflows/ci.yml/badge.svg)](https://github.com/ds-brandao/Lansweeper.Helpdesk-Python/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/lansweeper-helpdesk)](https://pypi.org/project/lansweeper-helpdesk/)
+[![Python](https://img.shields.io/pypi/pyversions/lansweeper-helpdesk)](https://pypi.org/project/lansweeper-helpdesk/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A Python SDK for the [Lansweeper Helpdesk API](https://www.lansweeper.com/). Create, retrieve, search, and manage helpdesk tickets programmatically.
+
+> **Note:** The Lansweeper Helpdesk API appears to be unmaintained and may be deprecated in the future. This SDK wraps the existing API as-is.
+
+## Installation
+
+```bash
+pip install lansweeper-helpdesk
+```
+
+## Quick Start
+
+```python
+from lansweeper_helpdesk import HelpdeskAPI
+
+api = HelpdeskAPI(
+    base_url="https://your-helpdesk-url:443/api.aspx",
+    api_key="your-api-key",
+    cert_path="/path/to/cert.pem",  # optional
+)
+
+# Create a ticket
+ticket = api.create_ticket(
+    subject="Network Issue",
+    description="Cannot reach internal network",
+    email="user@example.com",
+)
+
+# Get ticket details (HTML is auto-stripped)
+ticket = api.get_ticket("12345")
+print(ticket["Description"])
+```
+
+## API Reference
+
+### `HelpdeskAPI(base_url, api_key, cert_path=None)`
+
+Initialize the client.
+
+| Parameter   | Type            | Description                                        |
+|-------------|-----------------|----------------------------------------------------|
+| `base_url`  | `str`           | Base URL of the Lansweeper Helpdesk API             |
+| `api_key`   | `str`           | API key for authentication                          |
+| `cert_path` | `str` or `None` | Path to SSL certificate file (optional)             |
+
+### Ticket Operations
+
+#### `create_ticket(subject, description, email) -> dict`
+
+Create a new helpdesk ticket.
+
+```python
+api.create_ticket(
+    subject="Printer not working",
+    description="Office printer on floor 3 is offline",
+    email="user@company.com",
+)
+```
+
+#### `get_ticket(ticket_id) -> dict`
+
+Retrieve ticket details. HTML in the `Description` field is automatically converted to plain text.
+
+```python
+ticket = api.get_ticket("12345")
+```
+
+#### `get_ticket_history(ticket_id) -> list[dict]`
+
+Get all notes for a ticket. HTML content in note text fields is auto-stripped.
+
+```python
+notes = api.get_ticket_history("12345")
+for note in notes:
+    print(note["Text"])
+```
+
+#### `edit_ticket(ticket_id, state, ticket_type, email) -> dict`
+
+Update a ticket's state and type.
+
+```python
+api.edit_ticket(
+    ticket_id="12345",
+    state="Closed",
+    ticket_type="Hardware Repair",
+    email="agent@company.com",
+)
+```
+
+### Notes
+
+#### `add_note(ticket_id, text, email, note_type="Public") -> dict`
+
+Add a note to a ticket. Use `note_type="Internal"` for agent-only notes.
+
+```python
+api.add_note(
+    ticket_id="12345",
+    text="Router restart resolved the issue",
+    email="agent@company.com",
+    note_type="Internal",
+)
+```
+
+### Search
+
+#### `search_tickets(*, state, from_user_id, agent_id, description, subject, ticket_type, max_results, min_date, max_date) -> dict`
+
+Search tickets with optional filters. All parameters are keyword-only and optional.
+
+```python
+results = api.search_tickets(
+    state="Open",
+    ticket_type="Hardware Repair",
+    max_results=50,
+    min_date="2024-01-01",
+    max_date="2024-12-31",
+)
+```
+
+#### `get_user(email) -> dict`
+
+Look up a user by email address.
+
+```python
+user = api.get_user("user@company.com")
+```
+
+### Enums
+
+The SDK provides convenience enums for common values:
+
+```python
+from lansweeper_helpdesk import TicketState, NoteType
+
+api.search_tickets(state=TicketState.OPEN)
+api.add_note("12345", "note text", "a@b.com", note_type=NoteType.INTERNAL)
+```
+
+### Error Handling
+
+All API methods raise typed exceptions instead of returning `None`:
+
+```python
+from lansweeper_helpdesk import HelpdeskAPI, APIError, ConfigurationError
+
+try:
+    api = HelpdeskAPI(base_url="", api_key="key")
+except ConfigurationError as e:
+    print(f"Bad config: {e}")
+
+try:
+    ticket = api.get_ticket("99999")
+except APIError as e:
+    print(f"API error (HTTP {e.status_code}): {e}")
+```
+
+| Exception              | When                                              |
+|------------------------|----------------------------------------------------|
+| `HelpdeskError`        | Base class for all SDK exceptions                  |
+| `ConfigurationError`   | Invalid client configuration                       |
+| `APIError`             | HTTP or API-level error (has `.status_code`)       |
+| `TicketNotFoundError`  | Requested ticket does not exist                    |
+
+## Configuration
+
+You can load credentials from a JSON config file:
+
+```python
+import json
+from lansweeper_helpdesk import HelpdeskAPI
+
+with open("config/config.json") as f:
+    config = json.load(f)
+
+api = HelpdeskAPI(**config)
+```
+
+Example `config/config.json`:
+
+```json
+{
+    "base_url": "https://your-helpdesk-url:443/api.aspx",
+    "api_key": "your-api-key-here",
+    "cert_path": "path/to/your/certificate.pem"
+}
+```
+
+## Development
+
+```bash
+# Clone and install in dev mode
+git clone https://github.com/ds-brandao/Lansweeper.Helpdesk-Python.git
+cd Lansweeper.Helpdesk-Python
+pip install -e ".[dev]"
+
+# Run tests
+pytest --cov
+
+# Lint & format
+ruff check src/ tests/
+ruff format src/ tests/
+
+# Type check
+mypy src/
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for full guidelines.
+
+## License
+
+MIT License — see [LICENSE](LICENSE) for details.

lansweeper_helpdesk-0.1.0/pyproject.toml

@@ -0,0 +1,85 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "lansweeper-helpdesk"
+dynamic = ["version"]
+description = "Python SDK for the Lansweeper Helpdesk API — create, search, and manage helpdesk tickets programmatically."
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.10"
+authors = [
+    { name = "Daniel Brandao" },
+]
+keywords = ["lansweeper", "helpdesk", "api", "sdk", "itsm", "ticketing", "it-service-management"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: System :: Systems Administration",
+    "Typing :: Typed",
+]
+dependencies = [
+    "requests>=2.28",
+    "beautifulsoup4>=4.12",
+]
+
+[project.urls]
+Homepage = "https://github.com/ds-brandao/Lansweeper.Helpdesk-Python"
+Documentation = "https://github.com/ds-brandao/Lansweeper.Helpdesk-Python#readme"
+Repository = "https://github.com/ds-brandao/Lansweeper.Helpdesk-Python"
+Issues = "https://github.com/ds-brandao/Lansweeper.Helpdesk-Python/issues"
+Changelog = "https://github.com/ds-brandao/Lansweeper.Helpdesk-Python/blob/main/CHANGELOG.md"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "responses>=0.23",
+    "ruff>=0.4",
+    "mypy>=1.10",
+    "types-requests>=2.31",
+    "types-beautifulsoup4>=4.12",
+    "build>=1.0",
+]
+
+[tool.hatch.version]
+path = "src/lansweeper_helpdesk/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/lansweeper_helpdesk"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/",
+    "tests/",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md",
+    "pyproject.toml",
+]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W", "UP", "B", "SIM"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

lansweeper_helpdesk-0.1.0/src/lansweeper_helpdesk/__init__.py

@@ -0,0 +1,27 @@
+"""Lansweeper Helpdesk API SDK.
+
+A Python client for creating, retrieving, searching, and managing
+tickets in the Lansweeper Helpdesk system.
+"""
+
+from lansweeper_helpdesk.client import HelpdeskAPI
+from lansweeper_helpdesk.exceptions import (
+    APIError,
+    ConfigurationError,
+    HelpdeskError,
+    TicketNotFoundError,
+)
+from lansweeper_helpdesk.types import NoteType, TicketState
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "HelpdeskAPI",
+    "APIError",
+    "ConfigurationError",
+    "HelpdeskError",
+    "TicketNotFoundError",
+    "NoteType",
+    "TicketState",
+    "__version__",
+]