smallstep python

smallstep-python

Smallstep-Python เป็นไลบรารี Python ที่ช่วยให้คุณสามารถเชื่อมต่อกับ SmallStep API

เราใช้ openapi-python-client เพื่อสร้างไคลเอนต์ Python ระดับต่ำที่อยู่ใน smallstep/api_client/ ดู smallstep/README.md สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการใช้ไลบรารีที่สร้างขึ้นนี้ เราสร้างห้องสมุด wrapper ที่ด้านบนของ smallstep/api_client ที่ตั้งอยู่ใน api.py สิ่งนี้เพิ่มคุณสมบัติผู้ช่วยจำนวนหนึ่ง ในเวลานี้ smallstep/api.py รองรับจุดสิ้นสุด API เพียงไม่กี่จุดเท่านั้น ดูรายละเอียด smallstep/api.py

ความต้องการ

• Python 3.9
• บัญชี smallstep
• ความปรารถนาอย่างแรงกล้าที่จะอนุญาตให้งูน่ารักจัดการบัญชี smallstep ของคุณ

การติดตั้ง

เราเผยแพร่แพ็คเกจนี้ไปที่ https://pypi.org/project/smallstep-python/ และสามารถติดตั้งผ่าน PIP

pip install smallstep-python

การพัฒนา

การกำหนดค่า

สร้างไฟล์ .env ในรูทโครงการและเพิ่มบรรทัดต่อไปนี้:

 # 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 "

ปรับให้เข้ากับความต้องการของคุณ ดู config.py สำหรับรายละเอียดการกำหนดค่า เราใช้การตั้งค่า pydantic สำหรับการจัดการการตั้งค่าที่ง่าย ด้านล่างนี้เป็นลำดับความสำคัญสำหรับการตั้งค่าการกำหนดค่า:

1. อาร์กิวเมนต์ส่งผ่านไปยังคลาสการตั้งค่าเริ่มต้น
2. ตัวแปรสภาพแวดล้อมเช่น smallstep_my_config_setting ตามที่อธิบายไว้ข้างต้น
3. ตัวแปรที่โหลดจากไฟล์ dotenv (.env)
4. ตัวแปรโหลดจากไดเรกทอรีความลับ
5. ค่าฟิลด์เริ่มต้นสำหรับโมเดลการตั้งค่า

ดูส่วนลำดับความสำคัญของฟิลด์การตั้งค่า Pydantic สำหรับข้อมูลเพิ่มเติม

ด้วยบทกวี

ติดตั้งบทกวีในระบบของคุณด้วยสิ่งนี้

เรียกใช้สิ่งนี้จากไดเรกทอรี repo:

poetry install

เข้าสู่เชลล์บทกวีด้วยสิ่งนี้:

poetry shell
pre-commit install

กับ 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

การเพิ่มแพ็คเกจ

เพิ่มแพ็คเกจลงในบทกวีจากนั้นเรียกใช้ pre-commit ซึ่งจะสร้างไฟล์ข้อกำหนด. txt สำหรับคุณ

การพัฒนา:

poetry add --group=dev rich
pre-commit

การผลิต:

poetry add rich
pre-commit

ใบอนุญาต

Apache License Version 2.0

ลิขสิทธิ์ 2023 Smallstep Labs Inc.