Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
429 changes: 222 additions & 207 deletions .gitignore

Large diffs are not rendered by default.

402 changes: 201 additions & 201 deletions LICENSE

Large diffs are not rendered by default.

28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,27 @@
# python-t-cloud
# python-t-cloud

Python SDK for T-Cloud.

> **Status:** Early development. Not ready for production use.

## Quick Start

```bash
uv sync # install dependencies
uv run pytest # run tests
```

## Development

Requires [uv](https://docs.astral.sh/uv/) and Python 3.11+.

```bash
uv sync --group dev # install with dev dependencies
uv run ruff check src/ # lint
uv run mypy src/ # type check
uv run pytest -v # test
```

## License

Apache-2.0
18 changes: 18 additions & 0 deletions conftest.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# conftest.py at project root — registers the 'acceptance' marker
# and separates acceptance tests from unit tests.

import pytest


def pytest_collection_modifyitems(config, items):
"""Auto-mark tests under acceptance/ directory."""
for item in items:
if "acceptance" in str(item.fspath):
item.add_marker(pytest.mark.acceptance)


def pytest_configure(config):
config.addinivalue_line(
"markers",
"acceptance: marks tests that hit real OTC API (deselect with '-m \"not acceptance\"')",
)
26 changes: 26 additions & 0 deletions docs/api/core.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Core
====

Authentication
--------------

.. automodule:: sdk.core.auth
:members:
:show-inheritance:
:exclude-members: model_config, model_fields, model_computed_fields

Exceptions
----------

.. automodule:: sdk.core.exceptions
:members:
:undoc-members:
:show-inheritance:

Logging
-------

.. automodule:: sdk.core.log
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
API Reference
=============

.. toctree::
:maxdepth: 2

core
51 changes: 51 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
"""Sphinx configuration for the SDK documentation."""

import os
import sys

# Add src/ to path so autodoc can find the package
sys.path.insert(0, os.path.abspath("../src"))

# -- Project information -----------------------------------------------------

project = "SDK"
copyright = "2026, T Cloud Public"
author = "T Cloud Public"
release = "0.1.0"

# -- General configuration ---------------------------------------------------

extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon", # Google-style docstrings
"sphinx_autodoc_typehints", # type hints in docs
"sphinx.ext.viewcode", # [source] links
"sphinx.ext.intersphinx", # link to Python stdlib docs
]

# Napoleon settings (Google-style)
napoleon_google_docstring = True
napoleon_numpy_docstring = False
napoleon_include_init_with_doc = True
napoleon_include_private_with_doc = False
napoleon_use_param = True
napoleon_use_rtype = True

# Autodoc settings
autodoc_member_order = "bysource"
autodoc_typehints = "description"
autodoc_class_signature = "separated"
autodoc_pydantic_model_show_field_summary = False

# Intersphinx — link to Python docs
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"pydantic": ("https://docs.pydantic.dev/latest/", None),
}

# -- Options for HTML output -------------------------------------------------

html_theme = "sphinx_rtd_theme"
html_theme_options = {
"navigation_depth": 3,
}
9 changes: 9 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
SDK Documentation
=================

.. toctree::
:maxdepth: 2
:caption: Contents

quickstart
api/index
Loading