Update installation docs and possibly Django

Open

#1,300 opened on Sep 13, 2025 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 4/5
Estimated time: 3-5 days
Newbie friendliness: 35/100

Issue type: Documentation
Clarity: Mostly clear
Activity status: Stale
Tech stack: django, python
Domain: backend, documentation

Research direction

Read the README and Makefile to compare the documented non-Docker setup with the commands and requirements they use. Check the supported Python and Django versions, including the Python 3.13 compatibility issue. Done means the installation documentation clearly states the required versions and setup commands, with Django updated if that is needed for compatibility.

Written by the indexing model from the issue text.

Description

I was interested in looking at a couple of the issues here, but the docs for getting things setup seem to be missing a few bits of information, and the current setup is not compatible with the latest version of Python

Notably:

The Makefile relies on both pip and python being present, however on every system I've used in the past ~10 years (MacOS and Ubuntu, can't speak for Windows) whenever you install Python3 through the normal package managers (even if not alongside Python2), the commands are pip3 and python3 whereas pip and python have tended to always refer to Python2. This can be worked around with some aliases and a venv, but I feel like this requirement should be noted somewhere in the docs to identify what version of Python should be used and/or the other general requirements to run the project
Similar to the first issue, the current Django version is not compatible with the latest version of Python. Currently PokeAPI uses Django v3.2.25, which is a year and 2 major versions behind the latest. The issue is that this version still relies on the cgi module, which was removed from Python in version 3.13 last year, and it's not clear in the README what version of Python is actually recommended (I had presumed the latest, but that was not the case)

I am aware of the Docker instructions, but the point still stands that the non-Docker instructions seem to be outdated and such

Dominant language: Python
Stars: 5.4k
Forks: 1.2k
Avg merge: 2d 12h
Merged PRs (30d): 18

Contributor guide

Open the contributing guide

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.

Similar issues

PlaywrightRasterizer sizes the viewport from the root attributes, ignoring an inline style Open

bug priority:low

Difficulty 2/5 1-3 hours Newbie friendliness 76/100

CyberAgent/psd2svg#436 · Opened Sep 25, 2026
[Bug]: Linux launcher entry doesn't claim the window's app id — dock/taskbar shows a placeholder icon Open

area/install-update comp/cli comp/desktop P3 sweeper:risk-compatibility type/bug

Difficulty 2/5 1-3 hours Newbie friendliness 86/100

NousResearch/hermes-agent#122386 · 1 comment · Opened Sep 25, 2026
Symbol truncation can split multi-byte UTF-8 runes and cause valid profiles to be rejected Open

ai-generated

Difficulty 2/5 1-3 hours Newbie friendliness 78/100

grafana/pyroscope#5691 · Opened Sep 25, 2026
Router doesn't proxy /reset_prefix_cache, unlike /sleep//wake_up//is_sleeping Open

Difficulty 2/5 1-3 hours Newbie friendliness 78/100

vllm-project/production-stack#1105 · Opened Sep 25, 2026
hookify: hooks decode stdin with the Windows ANSI codepage — non-ASCII payloads silently corrupt and block rules fail open Open

Difficulty 2/5 1-3 hours Newbie friendliness 88/100

anthropics/claude-plugins-official#6306 · Opened Sep 25, 2026

More Python issues