pyedstem 0.1.0__tar.gz

pyedstem-0.1.0/.gitignore

@@ -0,0 +1,244 @@
+
+# General
+.DS_Store
+__MACOSX/
+.AppleDouble
+.LSOverride
+Icon[
+]
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

pyedstem-0.1.0/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: pyedstem
+Version: 0.1.0
+Summary: Easy-to-use Python client for the Ed Stem API
+Project-URL: Homepage, https://github.com/AlexDrBanana/pyedstem
+Project-URL: Repository, https://github.com/AlexDrBanana/pyedstem
+Project-URL: Issues, https://github.com/AlexDrBanana/pyedstem/issues
+Author: AlexDrBanana
+Keywords: api-client,ed-stem,edstem,education,python
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Education
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: markdownify>=1.2.0
+Requires-Dist: pydantic-settings>=2.8.1
+Requires-Dist: pydantic>=2.11.3
+Description-Content-Type: text/markdown
+
+# pyedstem
+
+Typed Python client for the Ed Stem API.
+
+`pyedstem` provides a small, sync-first interface for common Ed Stem tasks such
+as listing active courses, retrieving discussion threads, reading lessons, and
+posting answers back to Ed using the XML document format the API expects.
+
+## Installation
+
+### Install with pip
+
+```bash
+pip install pyedstem
+```
+
+### Add to a uv project
+
+```bash
+uv add pyedstem
+```
+
+## Configuration
+
+You can create a client directly with an API token:
+
+```python
+from pyedstem import EdStemClient
+
+client = EdStemClient(api_token="your-edstem-token")
+```
+
+Or load configuration from environment variables:
+
+- `EDSTEM_API_TOKEN` — required
+- `EDSTEM_BASE_URL` — optional, defaults to `https://edstem.org/api`
+- `EDSTEM_TIMEOUT_SECONDS` — optional, defaults to `30.0`
+
+```python
+from pyedstem import EdStemClient
+
+with EdStemClient.from_env() as client:
+    current_user = client.user.get_current_user()
+```
+
+## Quick start
+
+### List active courses
+
+```python
+from pyedstem import EdStemClient
+
+with EdStemClient.from_env() as client:
+    active_courses = client.courses.list_active()
+
+for course in active_courses:
+    print(course.id, course.code, course.name)
+```
+
+### Fetch unanswered discussion threads
+
+```python
+from pyedstem import EdStemClient
+
+course_id = 12345
+
+with EdStemClient.from_env() as client:
+    threads = client.workflows.list_course_unanswered_threads(course_id)
+
+for thread in threads:
+    print(f"#{thread.number}: {thread.title}")
+```
+
+### Post an answer
+
+```python
+from pyedstem import EdStemClient
+
+with EdStemClient.from_env() as client:
+    client.threads.post_answer(
+        thread_id=67890,
+        markdown="Hi there,\n\nThanks for the question...",
+    )
+```
+
+## Features
+
+- typed models for common Ed Stem responses
+- sync-first client API with resource groups
+- workflow helpers for active-course and unanswered-thread automation
+- markdown-to-Ed document conversion for answer posting
+- opt-in live contract tests for undocumented API drift detection
+
+## Development
+
+Clone the repository, then install development dependencies with uv:
+
+```bash
+uv sync --group dev
+```
+
+Run the test suite:
+
+```bash
+uv run pytest tests
+```
+
+### Live contract tests
+
+The repository includes an opt-in live suite under `tests/live/` that probes
+documented Ed endpoints so API changes can be detected early.
+
+Safe read-only live tests:
+
+```bash
+EDSTEM_RUN_LIVE_TESTS=1 uv run pytest tests/live/test_endpoint_contracts.py tests/live/test_restricted_endpoint_contracts.py
+```
+
+Opt-in write test for posting answers:
+
+```bash
+EDSTEM_RUN_WRITE_TESTS=1 \
+EDSTEM_WRITE_TEST_THREAD_ID=12345 \
+uv run pytest tests/live/test_write_endpoint_contracts.py
+```
+
+Only enable the write suite when it is safe to mutate real Ed data.
+
+## Publishing
+
+Build distribution artifacts with:
+
+```bash
+uv build
+```
+
+Publish to PyPI with:
+
+```bash
+uv publish
+```
+
+`uv publish` expects PyPI credentials or trusted publishing to be configured in
+the environment where you run the release.

pyedstem-0.1.0/README.md

@@ -0,0 +1,144 @@
+# pyedstem
+
+Typed Python client for the Ed Stem API.
+
+`pyedstem` provides a small, sync-first interface for common Ed Stem tasks such
+as listing active courses, retrieving discussion threads, reading lessons, and
+posting answers back to Ed using the XML document format the API expects.
+
+## Installation
+
+### Install with pip
+
+```bash
+pip install pyedstem
+```
+
+### Add to a uv project
+
+```bash
+uv add pyedstem
+```
+
+## Configuration
+
+You can create a client directly with an API token:
+
+```python
+from pyedstem import EdStemClient
+
+client = EdStemClient(api_token="your-edstem-token")
+```
+
+Or load configuration from environment variables:
+
+- `EDSTEM_API_TOKEN` — required
+- `EDSTEM_BASE_URL` — optional, defaults to `https://edstem.org/api`
+- `EDSTEM_TIMEOUT_SECONDS` — optional, defaults to `30.0`
+
+```python
+from pyedstem import EdStemClient
+
+with EdStemClient.from_env() as client:
+    current_user = client.user.get_current_user()
+```
+
+## Quick start
+
+### List active courses
+
+```python
+from pyedstem import EdStemClient
+
+with EdStemClient.from_env() as client:
+    active_courses = client.courses.list_active()
+
+for course in active_courses:
+    print(course.id, course.code, course.name)
+```
+
+### Fetch unanswered discussion threads
+
+```python
+from pyedstem import EdStemClient
+
+course_id = 12345
+
+with EdStemClient.from_env() as client:
+    threads = client.workflows.list_course_unanswered_threads(course_id)
+
+for thread in threads:
+    print(f"#{thread.number}: {thread.title}")
+```
+
+### Post an answer
+
+```python
+from pyedstem import EdStemClient
+
+with EdStemClient.from_env() as client:
+    client.threads.post_answer(
+        thread_id=67890,
+        markdown="Hi there,\n\nThanks for the question...",
+    )
+```
+
+## Features
+
+- typed models for common Ed Stem responses
+- sync-first client API with resource groups
+- workflow helpers for active-course and unanswered-thread automation
+- markdown-to-Ed document conversion for answer posting
+- opt-in live contract tests for undocumented API drift detection
+
+## Development
+
+Clone the repository, then install development dependencies with uv:
+
+```bash
+uv sync --group dev
+```
+
+Run the test suite:
+
+```bash
+uv run pytest tests
+```
+
+### Live contract tests
+
+The repository includes an opt-in live suite under `tests/live/` that probes
+documented Ed endpoints so API changes can be detected early.
+
+Safe read-only live tests:
+
+```bash
+EDSTEM_RUN_LIVE_TESTS=1 uv run pytest tests/live/test_endpoint_contracts.py tests/live/test_restricted_endpoint_contracts.py
+```
+
+Opt-in write test for posting answers:
+
+```bash
+EDSTEM_RUN_WRITE_TESTS=1 \
+EDSTEM_WRITE_TEST_THREAD_ID=12345 \
+uv run pytest tests/live/test_write_endpoint_contracts.py
+```
+
+Only enable the write suite when it is safe to mutate real Ed data.
+
+## Publishing
+
+Build distribution artifacts with:
+
+```bash
+uv build
+```
+
+Publish to PyPI with:
+
+```bash
+uv publish
+```
+
+`uv publish` expects PyPI credentials or trusted publishing to be configured in
+the environment where you run the release.

pyedstem-0.1.0/pyproject.toml

@@ -0,0 +1,51 @@
+[project]
+name = "pyedstem"
+version = "0.1.0"
+description = "Easy-to-use Python client for the Ed Stem API"
+readme = "README.md"
+requires-python = ">=3.13"
+authors = [
+    { name = "AlexDrBanana" },
+]
+keywords = ["edstem", "ed-stem", "education", "api-client", "python"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Education",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.28.1",
+    "markdownify>=1.2.0",
+    "pydantic>=2.11.3",
+    "pydantic-settings>=2.8.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/AlexDrBanana/pyedstem"
+Repository = "https://github.com/AlexDrBanana/pyedstem"
+Issues = "https://github.com/AlexDrBanana/pyedstem/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pyedstem"]
+
+[tool.hatch.build.targets.wheel.sources]
+"src" = ""
+
+[dependency-groups]
+dev = [
+    "pytest>=8.4.2",
+]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]

pyedstem-0.1.0/src/pyedstem/__init__.py

@@ -0,0 +1,12 @@
+"""Public package exports for pyedstem."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+from pyedstem.client import EdStemClient
+
+try:
+	__version__ = version("pyedstem")
+except PackageNotFoundError:
+	__version__ = "0.0.0"
+
+__all__ = ["EdStemClient", "__version__"]

pyedstem-0.1.0/src/pyedstem/client.py

@@ -0,0 +1,74 @@
+"""Top-level client for the Ed Stem API."""
+
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from pyedstem.config import get_settings
+from pyedstem.resources.analytics import AnalyticsResource
+from pyedstem.resources.challenges import ChallengesResource
+from pyedstem.resources.courses import CoursesResource
+from pyedstem.resources.lessons import LessonsResource
+from pyedstem.resources.threads import ThreadsResource
+from pyedstem.resources.user import UserResource
+from pyedstem.transport import EdStemTransport
+from pyedstem.workflow_client import WorkflowClient
+
+
+class EdStemClient:
+    """High-level sync client for the Ed Stem API."""
+
+    def __init__(
+        self,
+        *,
+        api_token: str,
+        base_url: str = "https://edstem.org/api",
+        timeout_seconds: float = 30.0,
+        http_client: httpx.Client | None = None,
+    ) -> None:
+        self._transport = EdStemTransport(
+            api_token=api_token,
+            base_url=base_url,
+            timeout_seconds=timeout_seconds,
+            client=http_client,
+        )
+        self.user = UserResource(self._transport)
+        self.courses = CoursesResource(self._transport)
+        self.threads = ThreadsResource(self._transport)
+        self.lessons = LessonsResource(self._transport)
+        self.analytics = AnalyticsResource(self._transport)
+        self.challenges = ChallengesResource(self._transport)
+        self.workflows = WorkflowClient(self)
+
+    @classmethod
+    def from_env(cls) -> "EdStemClient":
+        """Create a client from environment configuration."""
+        settings = get_settings()
+        return cls(
+            api_token=settings.api_token.get_secret_value(),
+            base_url=settings.base_url,
+            timeout_seconds=settings.timeout_seconds,
+        )
+
+    def close(self) -> None:
+        """Close the underlying HTTP transport."""
+        self._transport.close()
+
+    def get_json(
+        self,
+        path: str,
+        *,
+        params: dict[str, Any] | None = None,
+    ) -> dict[str, Any]:
+        """Perform a raw JSON GET request for less common endpoints."""
+        return self._transport.get_json(path, params=params)
+
+    def __enter__(self) -> "EdStemClient":
+        """Enter a context-managed client session."""
+        return self
+
+    def __exit__(self, exc_type: object, exc: object, tb: object) -> None:
+        """Always close HTTP resources when leaving a context manager."""
+        self.close()