📝 Update contributing docs

Author: tiangolo

docs/contributing.md

@@ -4,49 +4,43 @@ First, you might want to see the basic ways to [help SQLModel and get help](help
 
 ## Developing
 
-If you already cloned the repository and you know that you need to deep dive in the code, here are some guidelines to set up your environment.
+If you already cloned the <a href="https://github.com/fastapi/sqlmodel" class="external-link" target="_blank">sqlmodel repository</a> and you want to deep dive in the code, here are some guidelines to set up your environment.
 
-### Poetry
+### Virtual Environment
 
-**SQLModel** uses <a href="https://python-poetry.org/" class="external-link" target="_blank">Poetry</a> to build, package, and publish the project.
+Follow the instructions to create and activate a [virtual environment](virtual-environments.md){.internal-link target=_blank} for the internal code of `sqlmodel`.
 
-You can learn how to install it in the <a href="https://python-poetry.org/docs/#installation" class="external-link" target="_blank">Poetry docs</a>.
+### Install Requirements Using `pip`
 
-After having Poetry available, you can install the development dependencies:
+After activating the environment, install the required packages:
 
 <div class="termy">
 
 ```console
-$ poetry install
+$ pip install -r requirements.txt
 
 ---> 100%
 ```
 
 </div>
 
-It will also create a virtual environment automatically and will install all the dependencies and your local SQLModel in it.
+It will install all the dependencies and your local SQLModel in your local environment.
 
-### Poetry Shell
+### Using your Local SQLModel
 
-To use your current environment, and to have access to all the tools in it (for example `pytest` for the tests) enter into a Poetry Shell:
+If you create a Python file that imports and uses SQLModel, and run it with the Python from your local environment, it will use your cloned local SQLModel source code.
 
-<div class="termy">
-
-```console
-$ poetry shell
-```
+And if you update that local SQLModel source code when you run that Python file again, it will use the fresh version of SQLModel you just edited.
 
-</div>
-
-That will set up the environment variables needed and start a new shell with them.
+That way, you don't have to "install" your local version to be able to test every change.
 
-#### Using your local SQLModel
+/// note | "Technical Details"
 
-If you create a Python file that imports and uses SQLModel, and run it with the Python from your local Poetry environment, it will use your local SQLModel source code.
+This only happens when you install using this included `requirements.txt` instead of running `pip install sqlmodel` directly.
 
-And if you update that local SQLModel source code, when you run that Python file again, it will use the fresh version of SQLModel you just edited.
+That is because inside the `requirements.txt` file, the local version of SQLModel is marked to be installed in "editable" mode, with the `-e` option.
 
-Poetry takes care of making that work. But of course, it will only work in the current Poetry environment, if you install standard SQLModel in another environment (not from the source in the GitHub repo), that will use the standard SQLModel, not your custom version.
+///
 
 ### Format
 
@@ -62,41 +56,36 @@ $ bash scripts/format.sh
 
 It will also auto-sort all your imports.
 
-## Docs
-
-The documentation uses <a href="https://www.mkdocs.org/" class="external-link" target="_blank">MkDocs</a> with <a href="https://squidfunk.github.io/mkdocs-material/" class="external-link" target="_blank">Material for MkDocs</a>.
-
-All the documentation is in Markdown format in the directory `./docs`.
+## Tests
 
-Many of the tutorials have blocks of code.
+There is a script that you can run locally to test all the code and generate coverage reports in HTML:
 
-In most of the cases, these blocks of code are actual complete applications that can be run as is.
+<div class="termy">
 
-In fact, those blocks of code are not written inside the Markdown, they are Python files in the `./docs_src/` directory.
+```console
+$ bash scripts/test-cov-html.sh
+```
 
-And those Python files are included/injected in the documentation when generating the site.
+</div>
 
-### Docs for tests
+This command generates a directory `./htmlcov/`, if you open the file `./htmlcov/index.html` in your browser, you can explore interactively the regions of code that are covered by the tests, and notice if there is any region missing.
 
-Most of the tests actually run against the example source files in the documentation.
+## Docs
 
-This helps making sure that:
+First, make sure you set up your environment as described above, that will install all the requirements.
 
-* The documentation is up to date.
-* The documentation examples can be run as is.
-* Most of the features are covered by the documentation, ensured by test coverage.
+### Docs Live
 
 During local development, there is a script that builds the site and checks for any changes, live-reloading:
 
 <div class="termy">
 
 ```console
-$ bash scripts/docs-live.sh
+$ python ./scripts/docs.py live
 
-<span style="color: green;">[INFO]</span>    -  Building documentation...
-<span style="color: green;">[INFO]</span>    -  Cleaning site directory
-<span style="color: green;">[INFO]</span>    -  Documentation built in 2.74 seconds
-<span style="color: green;">[INFO]</span>    -  Serving on http://127.0.0.1:8008
+<span style="color: green;">[INFO]</span> Serving on http://127.0.0.1:8008
+<span style="color: green;">[INFO]</span> Start watching changes
+<span style="color: green;">[INFO]</span> Start detecting changes
 ```
 
 </div>
@@ -105,20 +94,71 @@ It will serve the documentation on `http://127.0.0.1:8008`.
 
 That way, you can edit the documentation/source files and see the changes live.
 
-## Tests
+/// tip
 
-There is a script that you can run locally to test all the code and generate coverage reports in HTML:
+Alternatively, you can perform the same steps that scripts does manually.
+
+Go into the docs director at `docs/`:
+
+```console
+$ cd docs/
+```
+
+Then run `mkdocs` in that directory:
+
+```console
+$ mkdocs serve --dev-addr 8008
+```
+
+///
+
+#### Typer CLI (Optional)
+
+The instructions here show you how to use the script at `./scripts/docs.py` with the `python` program directly.
+
+But you can also use <a href="https://typer.tiangolo.com/typer-cli/" class="external-link" target="_blank">Typer CLI</a>, and you will get autocompletion in your terminal for the commands after installing completion.
+
+If you install Typer CLI, you can install completion with:
 
 <div class="termy">
 
 ```console
-$ bash scripts/test.sh
+$ typer --install-completion
+
+zsh completion installed in /home/user/.bashrc.
+Completion will take effect once you restart the terminal.
 ```
 
 </div>
 
-This command generates a directory `./htmlcov/`, if you open the file `./htmlcov/index.html` in your browser, you can explore interactively the regions of code that are covered by the tests, and notice if there is any region missing.
+### Docs Structure
+
+The documentation uses <a href="https://www.mkdocs.org/" class="external-link" target="_blank">MkDocs</a>.
 
-## Thanks
+And there are extra tools/scripts in place in `./scripts/docs.py`.
 
-Thanks for contributing! ☕
+/// tip
+
+You don't need to see the code in `./scripts/docs.py`, you just use it in the command line.
+
+///
+
+All the documentation is in Markdown format in the directory `./docs`.
+
+Many of the tutorials have blocks of code.
+
+In most of the cases, these blocks of code are actual complete applications that can be run as is.
+
+In fact, those blocks of code are not written inside the Markdown, they are Python files in the `./docs_src/` directory.
+
+And those Python files are included/injected in the documentation when generating the site.
+
+### Docs for Tests
+
+Most of the tests actually run against the example source files in the documentation.
+
+This helps to make sure that:
+
+* The documentation is up-to-date.
+* The documentation examples can be run as is.
+* Most of the features are covered by the documentation, ensured by test coverage.