diff options
| author | Dimitri Staessens <dimitri@ouroboros.rocks> | 2026-07-26 13:49:26 +0200 |
|---|---|---|
| committer | Dimitri Staessens <dimitri@ouroboros.rocks> | 2026-07-26 14:50:26 +0200 |
| commit | 33f3c6fc4ca8810cee4c517594be725a26eec70c (patch) | |
| tree | c4b2f8c14357b1b4e979e01c3b516ddf254f3b98 /ouroboros/__init__.py | |
| parent | 3947452e391b1f1fc3933b28ce97d86e3b555d84 (diff) | |
| download | pyouroboros-33f3c6fc4ca8810cee4c517594be725a26eec70c.tar.gz pyouroboros-33f3c6fc4ca8810cee4c517594be725a26eec70c.zip | |
This is basically a clean up pass to make sure all docstrings are
aligned. The copyright banners are replaced by SPDX statements. Also
did a general clean up on the comments. Passes pylint. No structural
changes.
Signed-off-by: Dimitri Staessens <dimitri@ouroboros.rocks>
Diffstat (limited to 'ouroboros/__init__.py')
| -rw-r--r-- | ouroboros/__init__.py | 36 |
1 files changed, 8 insertions, 28 deletions
diff --git a/ouroboros/__init__.py b/ouroboros/__init__.py index a4de9bf..cbca95d 100644 --- a/ouroboros/__init__.py +++ b/ouroboros/__init__.py @@ -1,35 +1,15 @@ # -# Ouroboros - Copyright (C) 2016 - 2026 -# -# Python API for Ouroboros -# -# Dimitri Staessens <dimitri@ouroboros.rocks> -# -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public License -# version 2.1 as published by the Free Software Foundation. -# -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., http://www.fsf.org/about/contact/. +# SPDX-FileCopyrightText: 2016 - 2026 Dimitri Staessens +# SPDX-License-Identifier: LGPL-2.1-only # -"""Public Python API for Ouroboros. +""" +Public Python API for Ouroboros. -The package surface only re-exports pure-Python helpers (errors and -QoS). Applications import the load-bearing parts of the API from -their submodule explicitly: flows from :mod:`ouroboros.dev`, the -event loop from :mod:`ouroboros.event`, and the control plane from -:mod:`ouroboros.irm` (or :mod:`ouroboros.cli`). Submodule paths -make the caller's intent explicit and keep the package importable -in environments that have no business loading the libouroboros CFFI -extensions (see ``CLAUDE.md`` for the underlying init-on-load -behaviour that makes this contract load-bearing in practice). +The package surface re-exports the pure-Python helpers only: errors and +QoS. The rest of the API is imported from its submodule: flows from +:mod:`ouroboros.dev`, the event loop from :mod:`ouroboros.event`, the +control plane from :mod:`ouroboros.irm` (or :mod:`ouroboros.cli`). """ from __future__ import annotations |