Skip to content

Commit

Permalink
[CLEANUP]
Browse files Browse the repository at this point in the history
  • Loading branch information
Kye Gomez authored and Kye Gomez committed Jul 8, 2024
1 parent 515b519 commit 8849d5d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 55 deletions.
53 changes: 5 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
13 changes: 6 additions & 7 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>"]
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",
Expand All @@ -24,8 +24,7 @@ classifiers = [
[tool.poetry.dependencies]
python = "^3.10"
swarms = "*"
pydantic = "*"
fastapi = "*"


[tool.poetry.group.lint.dependencies]
ruff = "^0.4.8"
Expand Down

0 comments on commit 8849d5d

Please sign in to comment.