fastapi / sqlmodel

SQL databases in Python, designed for simplicity, compatibility, and robustness.
https://sqlmodel.tiangolo.com/
MIT License
14.18k stars 629 forks source link

docs/contributing.md outdated using poetry #948

Open jiangying000 opened 4 months ago

jiangying000 commented 4 months ago

Privileged issue

Issue Content

the doc is outdate because it's still using poetry while should be using pdm

https://github.com/tiangolo/sqlmodel/blob/376603efb2799f5b0565a7a29660601ed629d1fd/docs/contributing.md

shekhuverma commented 3 months ago

Hello @tiangolo, I also noticed this when making the development environment. After installing PDM and doing

pdm install -d

It creates a local venv and I'm also able to see the local changes made to sqlmodel. After activating the environment, when I do

pip list | grep mkdocs

I can see that mkdocs is installed in the newly created venv

mkdocs                          1.6.0
mkdocs-autorefs                 1.0.1
mkdocs-get-deps                 0.2.0
mkdocs-markdownextradata-plugin 0.2.5
mkdocs-material                 9.4.7
mkdocs-material-extensions      1.3.1
mkdocs-redirects                1.2.1
mkdocstrings                    0.23.0
mkdocstrings-python             1.9.1

But when I do

cd scripts
python docs.py

I get the error

ModuleNotFoundError: No module named 'mkdocs'

Can you please point me in the right direction if I'm doing anything wrong? I noticed this when I was building docs to see the changes.
Thank You!

smiling-watermelon commented 1 month ago

Also of note, the bash scripts/docs-live.sh command should be replaced with python scripts/docs.py live (or pdm run).