Skip to main content

Core utilities and models for keynet packages

Project description

keynet-core

Keynet 패키지들의 핵심 유틸리티와 공통 모델

설치

pip install keynet-core

주요 기능

🔧 공통 유틸리티

  • 환경 변수 관리
  • 설정 파일 처리
  • 로깅 설정

📦 공유 모델

  • 데이터 검증 모델
  • API 응답 모델
  • 설정 스키마

🔌 의존성

  • 최소한의 의존성 유지
  • 다른 Keynet 패키지의 기반

🔒 Security Features

자동 민감정보 마스킹 (Automatic Sensitive Data Redaction)

keynet-core는 stdout/stderr에 출력되는 민감정보를 자동으로 마스킹합니다.

보호되는 정보:

  • AWS Access Keys (AKIA...)
  • KEYNET_ prefix credentials (KEYNET_minio, KEYNET_storage 등)
  • Passwords, tokens, API keys (key=value 형태, 최소 3자)
  • Private keys (PEM format)
  • MLflow URIs with credentials
  • 환경변수 (AWS_, MLFLOW_, RABBIT_, KEYNET_, APP_API_KEY 등)

자동 활성화:

keynet-core를 설치하면 자동으로 redaction이 활성화됩니다:

pip install keynet-core
# Python 시작 시 자동으로 redaction 활성화!
# import 순서와 무관하게 보호됨
import os

# 환경변수 형태로 출력하면 자동 마스킹
os.environ["AWS_ACCESS_KEY_ID"] = "KEYNET_myaccess"
print(f"AWS_ACCESS_KEY_ID={os.getenv('AWS_ACCESS_KEY_ID')}")
# 출력: AWS_ACCESS_KEY_ID=***ENV_VAR_xxxx***

# KEYNET_ prefix 사용 시 명시적 감지
print("Using credential: KEYNET_myaccess")
# 출력: Using credential: ***KEYNET_KEY_xxxx***

권장사항: KEYNET_ Prefix 사용

개발 환경에서 MinIO credential에 KEYNET_ prefix를 사용하세요:

export AWS_ACCESS_KEY_ID=KEYNET_myaccess
export AWS_SECRET_ACCESS_KEY=KEYNET_mysecret
  • ✅ 자동 감지 보장
  • ✅ keynet 프로젝트 credential임을 명시

예외 메시지 sanitization:

from keynet_core.security import sanitize_exception

try:
    raise ValueError("Error: AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE")
except ValueError as e:
    sanitized = sanitize_exception(e)
    print(sanitized)
    # 출력: Error: AWS_ACCESS_KEY_ID=***ENV_VAR_xxxx***

디버깅 시 비활성화:

export KEYNET_DISABLE_REDACTION=1
python train.py

사용 예제

from keynet_core import Config, check_env

# 환경 변수 검증
if check_env():
    print("필수 환경 변수 설정 완료")

# 설정 로드
config = Config()
print(f"MLflow URI: {config.mlflow_tracking_uri}")

API 문서

자세한 API 문서는 GitHub Wiki 참조

라이선스

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

keynet_core-0.8.0.tar.gz (29.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

keynet_core-0.8.0-py3-none-any.whl (26.8 kB view details)

Uploaded Python 3

File details

Details for the file keynet_core-0.8.0.tar.gz.

File metadata

  • Download URL: keynet_core-0.8.0.tar.gz
  • Upload date:
  • Size: 29.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for keynet_core-0.8.0.tar.gz
Algorithm Hash digest
SHA256 448a63a990cb1aed9848df8e2a148fa90bfd9f8a32825920cac97734b115940b
MD5 4a0280be5db8d4da315c62d0018d4801
BLAKE2b-256 614226fa2d5655e3c2dc6b1622fb62bdd5eb9b818ac5512ed62915e0df8d0b28

See more details on using hashes here.

File details

Details for the file keynet_core-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: keynet_core-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 26.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for keynet_core-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 883e3ef53152b55ef40368e5586ab32bb6dee20eff2087de2bf6ed131ff6cc34
MD5 e1d0e7061a8048173a7544bf8564611a
BLAKE2b-256 d89e717bcf1cdb80b971b7dac317e190a5026f58c2e1a37c2c913f04425a319d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page