Update installation docs and possibly Django
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5.4k
- Forks
- 1.2k
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 21
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
Makefilerelies on bothpipandpythonbeing 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 arepip3andpython3whereaspipandpythonhave 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
cgimodule, 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
Contributor 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.
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.
Assessment
- Tech stack
- django, python
- Domain
- backend, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100