diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 106898af7dd4ed7612f190822cc618dd39192133..7cbcab7cac516dee6083f27835811b3c62a7bd74 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -2,6 +2,25 @@ ## Configure the package for local development +### New way (poetry) + +Install needed packages and GPTSwarm into the current environment. +```bash +poetry install +``` + +Install needed and uninstall not listed packages: +```bash +poetry install --sync +``` + +If dev packages not installed for some reason: +```bash +poetry install --with=dev --sync +``` + +### Old way (setuptools) + The following command installs the `gptswarm` package as a symbolic link to the current github repo clone. All edits to the repo will be immediately reflected in the "installed" package. ```bash pip insall -e . @@ -39,6 +58,12 @@ Test specific function: pytest -s test/swarm/graph/test_swarm.py -k 'test_raises' ``` +Running any of the above commands with poetry will auto activate the virtual environment: + +```bash +poetry run pytest -m mock_llm +``` + ## Run code coverage ```bash diff --git a/README.md b/README.md index 040ea36a76152254bef92d0ab0e63db46ac4873b..b75b6f7ceae30f1093eeef96f7286d3f51bc7446 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [](https://github.com/metauto-ai/gptswarm/issues) [](https://twitter.com/AI_KAUST) [](https://metauto.ai/images/wechat.jpeg) -[](https://coveralls.io/github/metauto-ai/GPTSwarm?branch=coveralls) +[](https://coveralls.io/github/metauto-ai/GPTSwarm?branch=main) <p align="left"> <a href=""><img src="swarm/utils/assets/logo.png" alt="GPTSwarm" width="430px"></a> @@ -17,8 +17,7 @@ ## News -✨ March 3, 2024: GPTSwarm support PyPI: ``pip install gptswarm``. - +✨ March 3, 2024: GPTSwarm can be installed via pip now: ``pip install gptswarm`` 🚀 Feb 27, 2024: Our academic paper: [Language Agents as Optimizable Graphs](https://arxiv.org/abs/2402.16823) is released. ## Edge optimization example