feat: support the full Hatching Triage API

.github/workflows/build.yml

@@ -24,6 +24,9 @@ jobs:
       - name: Set up project environment
         run: make setup
 
+      - name: Run tests
+        run: pipenv run pip install --editable . && pipenv run python3 -m pytest
+
       - name: Build package
         run: make build
 

.gitignore

@@ -8,3 +8,4 @@ docs/.doctrees/
 docs/
 dist/
 .DS_Store
+.venv/

Pipfile

@@ -4,12 +4,14 @@ verify_ssl = true
 name = "pypi"
 
 [packages]
-pydantic = "*"
-aiohttp = "*"
+pydantic = ">=2.5,<3"
+aiohttp = ">=3.9,<4"
 python-dateutil = "*"
 certifi = ">=2023.7.22"
 
 [dev-packages]
+pytest = "*"
+pytest-asyncio = "*"
 black = "*"
 setuptools = "*"
 build = "*"

README.md

@@ -2,12 +2,18 @@
 
 An async HTTP client to interact with the Hatching Triage Sandbox API (tria.ge).
 
-Supports:
-- Overview Reports
-- Sample submission
-- Sample searching
-- Individual sample retrieval
-- Profile getting/setting
-- Yara rule getting/setting
+Supports the whole Triage API (public, private, and self-hosted instances):
+- Sample submission (files, URLs, fetched URLs, and imports) and interactive profile selection
+- Sample searching, listing (owned/org/public), retrieval, and deletion - with pagination
+- Sample events (streamed status changes)
+- Overview, static, task (triage), summary, UrlScan, and kernel monitor reports
+- Sample, task file (pcaps, dropped files, memory dumps, screenshots), and archive downloads
+- Analysis profile management (including VPN geolocations)
+- Yara rule management
+- Resources (analysis environments), geolocations, and usage statistics
+- Magic link tokens and organization settings
+- User and API key management (private instances)
+
+`pyhatching.testing.FakeTriage` is a fake Triage API server for testing code built on pyhatching.
 
 Read the full documentation [here](https://gormo.co/docs/pyhatching/).

pyproject.toml

@@ -9,8 +9,14 @@ description = "An async Python client for the Hatching Triage Sandbox."
 readme = "README.md"
 requires-python = ">=3.11"
 dependencies = [
-    "aiohttp==3.8.4",
-    "pydantic==1.10.7",
+    "aiohttp>=3.9,<4",
+    "pydantic>=2.5,<3",
+]
+
+[project.optional-dependencies]
+test = [
+    "pytest>=8",
+    "pytest-asyncio>=0.23",
 ]
 
 [project.scripts]
@@ -29,3 +35,8 @@ Documentation = "https://gormo.co/pyhatching/"
 [tool.setuptools.packages.find]
 namespaces = true
 where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"