Skip to content
Draft
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
37 changes: 37 additions & 0 deletions docs/generate_docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
#!/bin/bash

# Chemins vers les packages racines (doivent contenir __init__.py et des sous-modules)
SCALEWAY_PKG="../scaleway/scaleway"
CORE_PKG="../scaleway-core/scaleway_core"
ASYNC_PKG="../scaleway-async/scaleway_async"

# Vérifier que les dossiers racines existent et sont bien des packages
for pkg in "$SCALEWAY_PKG" "$CORE_PKG" "$ASYNC_PKG"; do
if [ ! -d "$pkg" ]; then
echo "❌ Erreur : Le dossier '$pkg' n'existe pas."
exit 1
fi
if [ ! -f "$pkg/__init__.py" ] ; then
echo "⚠️ Attention : '$pkg' ne semble pas être un package Python (pas de __init__.py)."
fi
echo "✅ Package trouvé : $pkg"
done

# Exporter PYTHONPATH pour que tous les modules soient accessibles
export PYTHONPATH="..:$PYTHONPATH"

# Générer la doc pour chaque package racine (pdoc explore automatiquement les sous-modules)
echo "📚 Génération de la documentation avec pdoc..."
poetry run pdoc \
-o html \
-d google \
"$SCALEWAY_PKG" \
"$CORE_PKG" \
"$ASYNC_PKG"

if [ $? -eq 0 ]; then
echo "✅ Documentation générée avec succès dans le dossier 'html/'."
else
echo "❌ Échec de la génération de la documentation."
exit 1
fi
3 changes: 3 additions & 0 deletions scaleway-async/scaleway_async/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,7 @@
"ServiceInfo",
"TimeSeriesPoint",
"TimeSeries",
"InstanceV1API",
]

from scaleway_async.instance.v1 import InstanceV1API
24 changes: 24 additions & 0 deletions scaleway-async/scaleway_async/bridge.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# scaleway_async/bridge.py
from scaleway_core.bridge import (
Money,
Region,
ALL_REGIONS,
Zone,
ALL_ZONES,
ScwFile,
ServiceInfo,
TimeSeriesPoint,
TimeSeries,
)

__all__ = [
"Money",
"Region",
"ALL_REGIONS",
"Zone",
"ALL_ZONES",
"ScwFile",
"ServiceInfo",
"TimeSeriesPoint",
"TimeSeries",
]
54 changes: 5 additions & 49 deletions scaleway/scaleway/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,54 +2,10 @@

import importlib.metadata

__version__: str = importlib.metadata.version(__name__)
__version__ = importlib.metadata.version(__name__)

from scaleway_core.api import (
API,
ScalewayException,
)
# import internal dependencies
from ._dependancies import *

from scaleway_core.client import Client

from scaleway_core.profile import (
Profile,
ProfileConfig,
ProfileDefaults,
)

from scaleway_core.utils.waiter import (
WaitForOptions,
WaitForStopCondition,
)

from scaleway_core.bridge import (
Money,
Region,
ALL_REGIONS,
Zone,
ALL_ZONES,
ScwFile,
ServiceInfo,
TimeSeriesPoint,
TimeSeries,
)

__all__ = [
"API",
"ScalewayException",
"Client",
"Profile",
"ProfileConfig",
"ProfileDefaults",
"WaitForOptions",
"WaitForStopCondition",
"Money",
"Region",
"ALL_REGIONS",
"Zone",
"ALL_ZONES",
"ScwFile",
"ServiceInfo",
"TimeSeriesPoint",
"TimeSeries",
]
# optional: explicitly define __all__ for public API
# __all__ = _dependancies.__all__
52 changes: 52 additions & 0 deletions scaleway/scaleway/_dependancies.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# scaleway_async/_dependancies.py

from scaleway_core.api import (
API,
ScalewayException,
)

from scaleway_core.client import Client

from scaleway_core.profile import (
Profile,
ProfileConfig,
ProfileDefaults,
)

from scaleway_core.utils.waiter import (
WaitForOptions,
WaitForStopCondition,
)

from scaleway_core.bridge import (
Money,
Region,
ALL_REGIONS,
Zone,
ALL_ZONES,
ScwFile,
ServiceInfo,
TimeSeriesPoint,
TimeSeries,
)

__all__ = [
"API",
"ScalewayException",
"Client",
"Profile",
"ProfileConfig",
"ProfileDefaults",
"WaitForOptions",
"WaitForStopCondition",
"Money",
"Region",
"ALL_REGIONS",
"Zone",
"ALL_ZONES",
"ScwFile",
"ServiceInfo",
"TimeSeriesPoint",
"TimeSeries",
]

Loading