42api 0.1.0__tar.gz

42api-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "latest"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-extras --python ${{ matrix.python-version }}
+
+      - name: Ruff lint
+        run: uv run ruff check .
+
+      - name: Ruff format check
+        run: uv run ruff format --check .
+
+      - name: Check generated sync package is up to date
+        run: uv run python scripts/unasync_generate.py --check
+
+      - name: mypy
+        run: uv run mypy
+
+      - name: pytest
+        run: uv run pytest

42api-0.1.0/.gitignore

@@ -0,0 +1,221 @@
+# 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*
+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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+assets/

42api-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.5
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: local
+    hooks:
+      - id: unasync-check
+        name: check _sync is generated from _async
+        entry: uv run python scripts/unasync_generate.py --check
+        language: system
+        pass_filenames: false
+        files: ^src/intra42/_(async|sync)/
+
+      - id: mypy
+        name: mypy
+        entry: uv run mypy
+        language: system
+        pass_filenames: false
+        types: [python]

42api-0.1.0/LICENSE

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

42api-0.1.0/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.5
+Name: 42api
+Version: 0.1.0
+Summary: Object-oriented Python client for the 42 School API (api.intra.42.fr)
+Project-URL: Homepage, https://github.com/Shadowaker/42api
+Author-email: Dan <danyridolfo98@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: 42,42school,api,client,intra
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+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: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.0
+Description-Content-Type: text/markdown
+
+# 42api
+
+An object-oriented Python client for the [42 School API](https://api.intra.42.fr)
+(`api.intra.42.fr`) that handles OAuth2 authentication, request pacing, and
+pagination for you, so you can work with typed resources instead of raw JSON
+and HTTP plumbing.
+
+- **Sync and async** — `Client` and `AsyncClient` share one codebase and the
+  same interface.
+- **Typed models** — resources are [Pydantic v2](https://docs.pydantic.dev/)
+  models with IDE-friendly autocomplete.
+- **Automatic rate limiting** — requests are paced to stay under 42's limits;
+  `429`s are retried with backoff automatically.
+- **Lazy pagination** — iterate a query and it walks every page for you.
+
+## Install
+
+```bash
+uv add 42api
+# or: pip install 42api
+```
+
+## Usage
+
+```python
+from intra42 import Client
+
+with Client(client_id="...", client_secret="...") as client:
+    user = client.users.get("jdoe")
+    print(user.login, user.email)
+
+    for user in client.users.filter(campus_id=1).sort("-level"):
+        print(user.login)
+```
+
+Async is the same shape:
+
+```python
+import asyncio
+from intra42 import AsyncClient
+
+
+async def main() -> None:
+    async with AsyncClient(client_id="...", client_secret="...") as client:
+        user = await client.users.get("jdoe")
+        async for user in client.users.filter(campus_id=1).sort("-level"):
+            print(user.login)
+
+
+asyncio.run(main())
+```
+
+Fetched instances expose their nested resources directly — no need to
+build the scoped path yourself:
+
+```python
+campus = client.campuses.get(1)
+for event in campus.events:  # GET /campus/1/events
+    print(event.name)
+
+user = client.users.get("jdoe")
+for cu in user.campus_users:  # GET /users/jdoe/campus_users
+    print(cu.campus_id, cu.is_primary)
+```
+
+These (`campus.events`, `campus.users`, `user.events`, `user.campus_users`)
+are only available on instances fetched via a client — a manually
+constructed model raises a clear `RuntimeError` if accessed.
+
+Get your `client_id`/`client_secret` by registering an app at
+https://profile.intra.42.fr/oauth/applications. This library uses the
+**client credentials** flow, so it accesses the API as your app rather than
+as a specific logged-in user.
+
+## Errors
+
+All errors subclass `intra42.FortyTwoAPIError`, with subclasses for common
+HTTP statuses: `AuthenticationError` (401), `PermissionDeniedError` (403),
+`NotFoundError` (404), `ValidationError` (422), `RateLimitError` (429, only
+raised once the built-in retry budget is exhausted), `ServerError` (5xx),
+and `NetworkError` (connection/timeout failures).
+
+## Status
+
+Early-stage: currently covers `users`, `campuses`, `campus_users`,
+`events`, and `locations` (including its `graph` analytics endpoint). More
+resources are added incrementally on top of the same client/model/
+query-builder pattern.
+
+## Development
+
+Uses [uv](https://docs.astral.sh/uv/) for dependency management.
+
+```bash
+uv sync                                               # install dependencies
+uv run pytest                                         # run tests
+uv run ruff check . && uv run ruff format --check .   # lint
+uv run mypy                                           # type check
+```
+
+The sync client (`intra42._sync`) is generated from the async client
+(`intra42._async`) via [`unasync`](https://github.com/python-trio/unasync) —
+edit the async source and regenerate:
+
+```bash
+uv run python scripts/unasync_generate.py            # regenerate
+uv run python scripts/unasync_generate.py --check    # verify no drift (CI)
+```
+
+## License
+
+MIT

42api-0.1.0/README.md

@@ -0,0 +1,112 @@
+# 42api
+
+An object-oriented Python client for the [42 School API](https://api.intra.42.fr)
+(`api.intra.42.fr`) that handles OAuth2 authentication, request pacing, and
+pagination for you, so you can work with typed resources instead of raw JSON
+and HTTP plumbing.
+
+- **Sync and async** — `Client` and `AsyncClient` share one codebase and the
+  same interface.
+- **Typed models** — resources are [Pydantic v2](https://docs.pydantic.dev/)
+  models with IDE-friendly autocomplete.
+- **Automatic rate limiting** — requests are paced to stay under 42's limits;
+  `429`s are retried with backoff automatically.
+- **Lazy pagination** — iterate a query and it walks every page for you.
+
+## Install
+
+```bash
+uv add 42api
+# or: pip install 42api
+```
+
+## Usage
+
+```python
+from intra42 import Client
+
+with Client(client_id="...", client_secret="...") as client:
+    user = client.users.get("jdoe")
+    print(user.login, user.email)
+
+    for user in client.users.filter(campus_id=1).sort("-level"):
+        print(user.login)
+```
+
+Async is the same shape:
+
+```python
+import asyncio
+from intra42 import AsyncClient
+
+
+async def main() -> None:
+    async with AsyncClient(client_id="...", client_secret="...") as client:
+        user = await client.users.get("jdoe")
+        async for user in client.users.filter(campus_id=1).sort("-level"):
+            print(user.login)
+
+
+asyncio.run(main())
+```
+
+Fetched instances expose their nested resources directly — no need to
+build the scoped path yourself:
+
+```python
+campus = client.campuses.get(1)
+for event in campus.events:  # GET /campus/1/events
+    print(event.name)
+
+user = client.users.get("jdoe")
+for cu in user.campus_users:  # GET /users/jdoe/campus_users
+    print(cu.campus_id, cu.is_primary)
+```
+
+These (`campus.events`, `campus.users`, `user.events`, `user.campus_users`)
+are only available on instances fetched via a client — a manually
+constructed model raises a clear `RuntimeError` if accessed.
+
+Get your `client_id`/`client_secret` by registering an app at
+https://profile.intra.42.fr/oauth/applications. This library uses the
+**client credentials** flow, so it accesses the API as your app rather than
+as a specific logged-in user.
+
+## Errors
+
+All errors subclass `intra42.FortyTwoAPIError`, with subclasses for common
+HTTP statuses: `AuthenticationError` (401), `PermissionDeniedError` (403),
+`NotFoundError` (404), `ValidationError` (422), `RateLimitError` (429, only
+raised once the built-in retry budget is exhausted), `ServerError` (5xx),
+and `NetworkError` (connection/timeout failures).
+
+## Status
+
+Early-stage: currently covers `users`, `campuses`, `campus_users`,
+`events`, and `locations` (including its `graph` analytics endpoint). More
+resources are added incrementally on top of the same client/model/
+query-builder pattern.
+
+## Development
+
+Uses [uv](https://docs.astral.sh/uv/) for dependency management.
+
+```bash
+uv sync                                               # install dependencies
+uv run pytest                                         # run tests
+uv run ruff check . && uv run ruff format --check .   # lint
+uv run mypy                                           # type check
+```
+
+The sync client (`intra42._sync`) is generated from the async client
+(`intra42._async`) via [`unasync`](https://github.com/python-trio/unasync) —
+edit the async source and regenerate:
+
+```bash
+uv run python scripts/unasync_generate.py            # regenerate
+uv run python scripts/unasync_generate.py --check    # verify no drift (CI)
+```
+
+## License
+
+MIT

42api-0.1.0/pyproject.toml

@@ -0,0 +1,63 @@
+[project]
+name = "42api"
+version = "0.1.0"
+description = "Object-oriented Python client for the 42 School API (api.intra.42.fr)"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.10"
+authors = [{ name = "Dan", email = "danyridolfo98@gmail.com" }]
+dependencies = ["httpx>=0.27", "pydantic>=2.0"]
+
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "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",
+    "Typing :: Typed",
+    "Framework :: AsyncIO",
+]
+keywords = ["42", "42school", "api", "client", "intra"]
+
+[project.urls]
+Homepage = "https://github.com/Shadowaker/42api"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0",
+    "pytest-asyncio>=0.24",
+    "respx>=0.21",
+    "ruff>=0.6",
+    "mypy>=1.11",
+    "unasync>=0.6",
+    "pre-commit>=3.8",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/intra42"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]
+
+[tool.mypy]
+python_version = "3.10"
+packages = ["intra42"]
+mypy_path = "src"
+disallow_untyped_defs = true
+warn_unused_ignores = true