跳转到主要内容

ksEF API的Python接口

项目描述

Open in Dev Containers

ksEF

ksEF API的Python接口

使用

要将此软件包作为项目依赖项添加和安装,请运行poetry add ksEF

贡献

先决条件
1. 设置Git以使用SSH
  1. 生成SSH密钥并将SSH密钥添加到GitHub账户
  2. 配置SSH以自动加载您的SSH密钥
    cat << EOF >> ~/.ssh/config
    Host *
      AddKeysToAgent yes
      IgnoreUnknown UseKeychain
      UseKeychain yes
    EOF
    
2. 安装Docker
  1. 安装Docker Desktop.
3. 安装VS Code或PyCharm
  1. 安装VS Code并安装VS Code的Dev Containers扩展。或者,安装PyCharm
  2. 可选:安装一个Nerd Font,例如FiraCode Nerd Font,并配置VS Code配置PyCharm以使用它。
开发环境

以下开发环境得到支持

  1. ⭐️ GitHub Codespaces:点击代码并选择创建codespace以启动带有GitHub Codespaces的Dev Container。
  2. ⭐️ 开发容器(带有容器卷):点击 在开发容器中打开 以在容器卷中克隆此存储库并创建带有 VS Code 的开发容器。
  3. 开发容器:克隆此存储库,用 VS Code 打开它,然后运行 Ctrl/⌘ + + P开发容器:在容器中重新打开
  4. PyCharm:克隆此存储库,用 PyCharm 打开它,并使用 dev 服务将 Docker Compose 配置为远程解释器
  5. 终端:克隆此存储库,用您的终端打开它,然后运行 docker compose up --detach dev 以在后台启动开发容器,然后运行 docker compose exec dev zsh 以在开发容器中打开一个 shell 提示符。
开发
  • 本项目遵循 Conventional Commits 标准,以自动化 语义版本控制保持更改日志,并使用 Commitizen
  • 在开发环境中运行 poe 以打印此项目上可运行的 Poe the Poet 任务的列表。
  • 在开发环境中运行 poetry add {package} 以安装运行时依赖项并将其添加到 pyproject.tomlpoetry.lock 中。添加 --group test--group dev 以安装 CI 或开发依赖项。
  • 在开发环境中运行 poetry update 以将所有依赖项升级到 pyproject.toml 允许的最新版本。
  • 运行 cz bump 以增加软件包的版本,更新 CHANGELOG.md 并创建 git 标签。

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面