Schrijf de handleiding voor een nieuwe map

Maak README.md af voor iemand die begint in een nieuwe, lege map waarin het project is uitgepakt. Vermeld Python 3.10+ en laat elk commando rechtstreeks de interpreter van de omgeving kiezen; activering en shelltoestand zijn niet nodig.

Neem onder macOS and Linux precies deze volgorde op:

python3 -m venv .venv
./.venv/bin/python -m pip install -r requirements-dev.txt
./.venv/bin/python -m pytest -q
./.venv/bin/python api_catalog.py --help

Neem onder PowerShell dit op:

py -3 -m venv .venv
.\.venv\Scripts\python.exe -m pip install -r requirements-dev.txt
.\.venv\Scripts\python.exe -m pytest -q
.\.venv\Scripts\python.exe .\api_catalog.py --help

Leg uit dat een gebruiker die alleen het programma wil uitvoeren in plaats daarvan requirements.txt installeert, dat pip de ingestelde package-index van de interpreter gebruikt en dat je een importfout oplost door terug te gaan naar de hoofdmap van het uitgepakte project. Raad nooit globale pip, activering of wijzigingen aan het uitvoeringsbeleid aan.

Het gedownloade project kan buiten de site opnieuw worden opgebouwd, worden geïmporteerd en getest, en hulp tonen. De vaste hostnaam practice-api is intern voor Python Land. Een echt ophaalverzoek zal na het downloaden dus naar verwachting niet slagen. Voeg geen openbare of instelbare host, geheim of uitweg via een omgevingsvariabele toe.