From 8849d5d662fe232266451f1e195649355c94759f Mon Sep 17 00:00:00 2001 From: Kye Gomez Date: Mon, 8 Jul 2024 11:53:50 -0700 Subject: [PATCH] [CLEANUP] --- README.md | 53 +++++--------------------------------------------- pyproject.toml | 13 ++++++------- 2 files changed, 11 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 3a00e59..028b998 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,16 @@ [![Multi-Modality](agorabanner.png)](https://discord.gg/qUtxnK2NMf) -# Multi-Agent Template App -A radically simple, reliable, and high performance template to enable you to quickly get set up building multi-agent applications +# Swarms Memory +A collection of memory systems for `swarms` such as Pinecone, ChromaDB, Weaviate - - -## Installation - -You can install the package using pip - +## Install ```bash -$ pip3 install -r requirements.txt +$ pip install swarms-memory ``` -### Code Quality ๐Ÿงน - -- `make style` to format the code -- `make check_code_quality` to check code quality (PEP8 basically) -- `black .` -- `ruff . --fix` - -### Tests ๐Ÿงช - -[`pytests`](https://docs.pytest.org/en/7.1.x/) is used to run our tests. - -### Publish on PyPi ๐Ÿš€ - -**Important**: Before publishing, edit `__version__` in [src/__init__](/src/__init__.py) to match the wanted new version. - -``` -poetry build -poetry publish -``` - -### CI/CD ๐Ÿค– - -We use [GitHub actions](https://github.com/features/actions) to automatically run tests and check code quality when a new PR is done on `main`. - -On any pull request, we will check the code quality and tests. - -When a new release is created, we will try to push the new code to PyPi. We use [`twine`](https://twine.readthedocs.io/en/stable/) to make our life easier. - -The **correct steps** to create a new realease are the following: -- edit `__version__` in [src/__init__](/src/__init__.py) to match the wanted new version. -- create a new [`tag`](https://git-scm.com/docs/git-tag) with the release name, e.g. `git tag v0.0.1 && git push origin v0.0.1` or from the GitHub UI. -- create a new release from GitHub UI - -The CI will run when you create the new release. - -# Docs -We use MK docs. This repo comes with the zeta docs. All the docs configurations are already here along with the readthedocs configs. - - +## Usage # License MIT diff --git a/pyproject.toml b/pyproject.toml index 172bd11..6f7c940 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,15 +3,15 @@ requires = ["poetry-core>=1.0.0"] build-backend = "poetry.core.masonry.api" [tool.poetry] -name = "paper" +name = "swarms-memory" version = "0.0.1" -description = "Paper - Pytorch" +description = "Swarms Memory - Pytorch" license = "MIT" authors = ["Kye Gomez "] -homepage = "https://github.com/kyegomez/paper" -documentation = "https://github.com/kyegomez/paper" # Add this if you have documentation. +homepage = "https://github.com/kyegomez/swarms-memory" +documentation = "https://github.com/kyegomez/swarms-memory" readme = "README.md" # Assuming you have a README.md -repository = "https://github.com/kyegomez/paper" +repository = "https://github.com/kyegomez/swarms-memory" keywords = ["artificial intelligence", "deep learning", "optimizers", "Prompt Engineering"] classifiers = [ "Development Status :: 4 - Beta", @@ -24,8 +24,7 @@ classifiers = [ [tool.poetry.dependencies] python = "^3.10" swarms = "*" -pydantic = "*" -fastapi = "*" + [tool.poetry.group.lint.dependencies] ruff = "^0.4.8"