Skip to main content

ChatArch typed environment profile manager

Project description

ChatEnv

ChatArch typed env/profile runtime.

ChatEnv 是 ChatArch / chatxxx 系列项目共用的 typed env/profile 底层包。它只提供字段描述、配置基类、registry、路径、profile 文件读写、mask 和 paste 解析等通用能力;具体变量由 ChatTool、ChatDNS 等项目自己定义并注册。

当前设计保持减法:只使用一个根变量 CHATARCH_HOME,只管理 env/profile 文件,不额外创建 config/cache/data/state。

支持 Python >=3.10

安装

pip install chatenv --upgrade
pip install -e .[dev]       # 仓库开发

目录

CHATARCH_HOME=${CHATARCH_HOME:-~/.chatarch}
$CHATARCH_HOME/envs/

实际布局由业务项目注册的 schema 决定,例如:

~/.chatarch/envs/
  Example/
    .env
    work.env
  • .env 是当前 active profile;
  • name.env 是 named profile;
  • use 会把 named profile 复制为 active .env

CLI 概览

chatenv CLI 基于已注册 schema 工作。单独安装且没有项目注册 schema 时,它会提示需要先注册配置类型。业务项目通常会在自己的 CLI 中导入 schema 后复用这些能力。

chatenv init -t example
chatenv cat -t example
chatenv cat -t example --no-mask | chatenv paste --stdin --profile work --yes
chatenv set EXAMPLE_API_KEY=sk-xxx
chatenv get EXAMPLE_API_KEY
chatenv new -t example work
chatenv save -t example work
chatenv use -t example work
chatenv delete -t example work

单次命令可通过 --home 覆盖根目录:

chatenv --home /tmp/chatarch cat -t example

更多用法见 docs/cli.md

Paste

paste 是跨设备复制密钥的核心入口。输入不要求是严格 dotenv 文件,会从终端日志、shell prompt、复制文本里提取已注册 key。

chatenv paste
chatenv paste --stdin --profile work
chatenv paste --value "EXAMPLE_API_KEY='sk-xxx'" --yes

写入前会输出识别概要:识别到哪些类型、哪些 key、未知 key 被忽略。

Python API

from chatenv import BaseEnvConfig, EnvField, EnvStore, get_paths

class ExampleConfig(BaseEnvConfig):
    _title = "Example Configuration"
    _aliases = ["example"]
    _storage_dir = "Example"

    EXAMPLE_API_KEY = EnvField("EXAMPLE_API_KEY", is_sensitive=True)

paths = get_paths()
store = EnvStore(paths.envs_dir)
store.save_active(ExampleConfig, {"EXAMPLE_API_KEY": "sk-..."})

文档

  • docs/cli.md:CLI 用法
  • docs/design.md:路径、数据布局与注册策略
  • docs/developer-guide.md:chatxxx 项目接入和 provider 开发指南
  • docs/development.md:测试、构建与发布
  • mkdocs.yml:Material for MkDocs 文档站点配置

开发

python -m pytest -q
python -m build
python -m twine check dist/*
python -m pip install -e .[docs]
python -m mkdocs serve

也可以用 ChatTool helper:

chattool pypi build --project-dir .
chattool pypi check --project-dir .

开源协议

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

chatenv-0.1.1.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

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

chatenv-0.1.1-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file chatenv-0.1.1.tar.gz.

File metadata

  • Download URL: chatenv-0.1.1.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for chatenv-0.1.1.tar.gz
Algorithm Hash digest
SHA256 739aa2617f5b78e6cdcdc1bf4562479b77ca9acba81c2f38b7a02af7022edc45
MD5 49a4b14bdd80f96ef688cb9bb29d0d89
BLAKE2b-256 6ad4dec05782a45aee5ba796b0af57736b3c998a06414c3caaba41574ca1a621

See more details on using hashes here.

File details

Details for the file chatenv-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: chatenv-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for chatenv-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e5149364e1a6a3bb6628682de85fde010e2d4e06f544285ade13e18eb3bf52dd
MD5 d03c65d9f8755a0cf6b86b1978c296ee
BLAKE2b-256 b8e97b55842030396b561c824a16ddfb6b53c9d594878f962d08784af8a1e1be

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