d503c0bf33
This PR introduces the `--build-command` and `--install-command` arguments to `langgraph build`. `--install-command` is a custom install command. If passed, it will be run from wherever the `langgraph build` call was made, i.e. NOT where the langgraph.json file lives (except if these are the same place). This will override the detected install command that we previously used. `--build-command` is a custom build command. This will run from wherever the langgraph.json file lives, and will be done after the install has been run. You don't need to provide both. Just providing one will make the install (detected or supplied) run in the directory from where `langgraph build was called` and then have the build command (if one exists) run in the directory where langgraph.json exists. I think we should probably allow configuring the directories from which these commands get run, but I don't think this needs to be part of the MVP. --------- Co-authored-by: William FH <13333726+hinthornw@users.noreply.github.com>
Setup
To setup requirements for building docs you can run:
uv sync --group test
Serving documentation locally
To run the documentation server locally you can run:
make serve-docs
This will start the documentation server on http://127.0.0.1:8000/langgraph/.
Execute notebooks
If you would like to automatically execute all of the notebooks, to mimic the "Run notebooks" GHA, you can run:
python _scripts/prepare_notebooks_for_ci.py
./_scripts/execute_notebooks.sh
Note: if you want to run the notebooks without %pip install cells, you can run:
python _scripts/prepare_notebooks_for_ci.py --comment-install-cells
./_scripts/execute_notebooks.sh
prepare_notebooks_for_ci.py script will add VCR cassette context manager for each cell in the notebook, so that:
- when the notebook is run for the first time, cells with network requests will be recorded to a VCR cassette file
- when the notebook is run subsequently, the cells with network requests will be replayed from the cassettes
Adding new notebooks
If you are adding a notebook with API requests, it's recommended to record network requests so that they can be subsequently replayed. If this is not done, the notebook runner will make API requests every time the notebook is run, which can be costly and slow.
To record network requests, please make sure to first run prepare_notebooks_for_ci.py script.
Then, run
jupyter execute <path_to_notebook>
Once the notebook is executed, you should see the new VCR cassettes recorded in cassettes directory and discard the updated notebook.
Updating existing notebooks
If you are updating an existing notebook, please make sure to remove any existing cassettes for the notebook in cassettes directory (each cassette is prefixed with the notebook name), and then run the steps from the "Adding new notebooks" section above.
To delete cassettes for a notebook, you can run:
rm cassettes/<notebook_name>*