Complete optional Python project modernization

未关闭
#114 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
20/100
Issue 类型
重构
描述清晰度
需要澄清
活跃度
活跃
技术栈
github-actions, python

调研方向

Start by reading issue 114 and inventory setup.py, setup.cfg, MANIFEST.in, requirements files, GitHub Actions workflows, and release configuration. Split the modernization candidates into independently deliverable child tickets before implementation. Done requires focused compatibility checks, artifact parity where relevant, non-uploading publishing verification, rollback documentation, and deterministic CI without live credentials.

由索引模型根据 Issue 内容生成。

描述

enhancement

Motivation

After the compatibility, reproducibility, CI, and documentation bugs are fixed, several optional modernization opportunities will remain. They can improve maintainability and release security, but they are not required to restore currently promised behavior and should not be mixed into the bug fixes.

Candidate scope

  • Evaluate retaining, upgrading, replacing, or removing observable; version 1.x changes behavior used by the SDK and is a compatibility migration rather than a routine version bump.
  • Upgrade websockets, documentation, development, coverage, and build dependencies with focused compatibility checks.
  • Upgrade GitHub Actions and choose an explicit third-party action pinning policy.
  • Upgrade or replace the GitHub Pages deployment action.
  • Remove superseded setup.py, setup.cfg, MANIFEST.in, and requirements files only after artifact and workflow parity is established.
  • Reconsider whether tests should ship in distributions and whether demos should be included, without silently changing artifact contents.
  • Add useful optional project metadata.
  • Evaluate PyPI Trusted Publishing and uv publish while preserving or explicitly redesigning tag-driven version and release behavior.
  • Consider optional credentialed live compatibility smoke tests outside deterministic unit CI.

Acceptance criteria

  • Each proposed dependency or tooling upgrade has a documented compatibility reason and focused verification.
  • Observable compatibility is resolved deliberately rather than treated as an automatic version bump.
  • Any packaging-file or artifact-content cleanup occurs only after parity is demonstrated and the intended change is explicit.
  • Any release-authentication or publishing change has a non-uploading dry run and documented rollback path.
  • Deterministic unit CI remains independent of live credentials.
  • The enhancement is split into independently deliverable child tickets before implementation begins.
主要语言
Python
星标
56
派生
40
PR 合并指标
30 天内没有已合并 PR

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

ringcentral/ringcentral-python 的其他 Issue

查看 ringcentral/ringcentral-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。