[Bug]: Local development setup fails on a fresh clone due to missing setuptools pin
メンテナーはふだん 1 日以内に返信
評価
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 初心者へのやさしさ
- 92/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- python
調査の方向性
en/requirements.txt から始め、その依存関係の固定バージョンを Dockerfile に既存の setuptools<80 の指定と比較します。新しい仮想環境のセットアップを再現し、pip install -r requirements.txt を実行して、python -m mkdocs build が pkg_resources エラーなしで完了することを確認します。
索引モデルが issue の本文から書いたものです。
説明
Description
On a fresh clone, pip install -r requirements.txt succeeds but
python -m mkdocs build fails with:
ModuleNotFoundError: No module named 'pkg_resources'
markdown==3.2.1 requires pkg_resources, which setuptools removed in
version 82.0.0. setuptools is not pinned in en/requirements.txt, so pip
installs the latest version.
The Dockerfile already pins setuptools<80, so container builds are fine —
only local setup is broken. Existing contributors don't see this because their
virtual environments already have an older setuptools.
Fix: add setuptools<80 to en/requirements.txt to match the Dockerfile.
Steps to Reproduce
- Clone the repository:
git clone https://github.com/wso2/docs-api-platform.git
- Create and activate a virtual environment:
cd docs-api-platform
python3 -m venv venv
source venv/bin/activate
- Install the dependencies:
cd en
pip install -r requirements.txt
- Build the site:
python -m mkdocs build
Result: the build fails with:
File ".../site-packages/markdown/core.py", line 26, in <module>
import pkg_resources
ModuleNotFoundError: No module named 'pkg_resources'
Version
main @ 5aab8ab
Environment Details (with versions)
OS: Ubuntu 24.04
Python 3.12.11, pip 26.2.1, setuptools 84.0.0, markdown 3.2.1, mkdocs 1.4.2
- 主要言語
- CSS
- スター
- 3
- フォーク
- 74
- 平均マージ
- 17時間 37分
- マージ済み PR(30日)
- 187
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
wso2/docs-api-platform のほかの issue
-
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
wso2/docs-api-platform#529 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
wso2/docs-api-platform#500 ·
メンテナーはふだん 1 日以内に返信
-
Priority/Normal Severity/Major Type/Docs Type/Improvement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
wso2/docs-api-platform#455 ·
メンテナーはふだん 1 日以内に返信
-
API Gateway Docs - Setup instructions appear before the Quick Start対応中かも @kavishannip が 96 日前に担当しました。 オープンPriority/Highest Severity/Critical
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
wso2/docs-api-platform#330 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Doc Feedback: Chart config in "Bottom-Up (Gateway → On-Prem APIM)"再び着手できるかも @Krishmal2004 が 53 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
wso2/docs-api-platform#277 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
wso2/docs-api-platform の issue をすべて見る
似ている issue
-
難易度 1/5 1〜3時間 初心者へのやさしさ 66/100
betagouv/conseillers-entreprises#4770 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
awsdocs/amazon-eks-user-guide#1257 ·
-
deep-dive-feedback
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
aws-samples/sample-apex-skills#292 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
italia/eid-wallet-it-docs#1253 ·
メンテナーはふだん 13 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信