smallstep python

Smallstep-Python

Mit Snallstep-Python ist eine Python-Bibliothek bei Ihnen die Schnittstelle mit der Smallstep-API.

Wir verwenden OpenAPI-Python-Client, um einen Python-Client mit niedrigem Niveau zu erzeugen, der sich in smallstep/api_client/ befindet. Weitere Informationen zur Verwendung dieser generierten Bibliothek finden Sie im smallstep/README.md . Wir haben eine Wrapper -Bibliothek über smallstep/api_client in api.py erstellt. Dies fügt eine Handvoll Helferfunktionen hinzu. Zu diesem Zeitpunkt unterstützt smallstep/api.py nur einige API -Endpunkte. Einzelheiten siehe smallstep/api.py .

Anforderungen

• Python 3.9
• Smallstep -Konto
• Ein sehr starker Wunsch, einer niedlichen Schlange Ihr Smallstep -Konto zu verwalten

Installation

Wir veröffentlichen dieses Paket auf https://pypi.org/project/smallstep-python/ und kann über PIP installiert werden.

pip install smallstep-python

Entwicklung

Konfiguration

Erstellen Sie eine .env -Datei im Projektroot und fügen Sie die folgenden Zeilen hinzu:

 # Not needed unless you are using our run anywhere offering
# SMALLSTEP_API_HOST="https://gateway.smallstep.com/api"
SMALLSTEP_API_TOKEN= " your_smallstep_api_token "

Passen Sie sie an Ihre Bedürfnisse an. In config.py finden Sie Konfigurationsdetails. Wir verwenden pydantische Einstellungen für die einfache Einstellungsverwaltung. Im Folgenden finden Sie die Vorrangsreihenfolge für Konfigurationseinstellungen:

1. Argumente, die an den Einstellungsklassen -Initialiser übergeben wurden.
2. Umgebungsvariablen, z. B. smallstep_my_config_seting wie oben beschrieben.
3. Variablen aus einer DOTENV (.env) -Datei geladen.
4. Variablen aus dem Secrets -Verzeichnis geladen.
5. Die Standardfeldwerte für das Einstellungsmodell.

Weitere Informationen finden Sie im Bereich Pydantic -Einstellungen der Feldwert Priorität.

Mit Poesie

Installieren Sie die Gedichte in Ihrem System damit.

Führen Sie dies aus dem Repo -Verzeichnis aus:

poetry install

Geben Sie damit die Gedichthülle ein:

poetry shell
pre-commit install

Mit Venv

 export VIRTUAL_ENV= ${PWD} /.venv
python3 -m venv $VIRTUAL_ENV
export PATH= " $VIRTUAL_ENV /bin: $PATH "
pip install wheel
pip install -r requirements.txt
. .venv/bin/activate
pre-commit install

Hinzufügen von Paketen

Fügen Sie Pakete zur Poesie hinzu und führen Sie dann Pre-Commit aus, wodurch eine Anforderungen für Sie generiert wird.

Entwicklung:

poetry add --group=dev rich
pre-commit

Produktion:

poetry add rich
pre-commit

Lizenz

Apache -Lizenzversion 2.0

Copyright 2023 Smallstep Labs Inc.