chore: migrate package name to letta (#1775)
Co-authored-by: Charles Packer <packercharles@gmail.com> Co-authored-by: Shubham Naik <shubham.naik10@gmail.com> Co-authored-by: Shubham Naik <shub@memgpt.ai>
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
# 🚀 How to Contribute to MemGPT
|
||||
# 🚀 How to Contribute to Letta
|
||||
|
||||
Thank you for investing time in contributing to our project! Here's a guide to get you started.
|
||||
|
||||
@@ -6,9 +6,9 @@ Thank you for investing time in contributing to our project! Here's a guide to g
|
||||
|
||||
### 🍴 Fork the Repository
|
||||
|
||||
First things first, let's get you a personal copy of MemGPT to play with. Think of it as your very own playground. 🎪
|
||||
First things first, let's get you a personal copy of Letta to play with. Think of it as your very own playground. 🎪
|
||||
|
||||
1. Head over to the MemGPT repository on GitHub.
|
||||
1. Head over to the Letta repository on GitHub.
|
||||
2. In the upper-right corner, hit the 'Fork' button.
|
||||
|
||||
### 🚀 Clone the Repository
|
||||
@@ -16,7 +16,7 @@ First things first, let's get you a personal copy of MemGPT to play with. Think
|
||||
Now, let's bring your new playground to your local machine.
|
||||
|
||||
```shell
|
||||
git clone https://github.com/your-username/MemGPT.git
|
||||
git clone https://github.com/your-username/Letta.git
|
||||
```
|
||||
|
||||
### 🧩 Install Dependencies
|
||||
@@ -25,45 +25,45 @@ git clone https://github.com/your-username/MemGPT.git
|
||||
|
||||
First, install Poetry using [the official instructions here](https://python-poetry.org/docs/#installation).
|
||||
|
||||
Once Poetry is installed, navigate to the MemGPT directory and install the MemGPT project with Poetry:
|
||||
Once Poetry is installed, navigate to the Letta directory and install the Letta project with Poetry:
|
||||
```shell
|
||||
cd MemGPT
|
||||
cd Letta
|
||||
poetry shell
|
||||
poetry install -E dev -E postgres -E local
|
||||
```
|
||||
|
||||
Now when you want to use `memgpt`, make sure you first activate the `poetry` environment using poetry shell:
|
||||
Now when you want to use `letta`, make sure you first activate the `poetry` environment using poetry shell:
|
||||
```shell
|
||||
$ poetry shell
|
||||
(pymemgpt-py3.10) $ memgpt run
|
||||
(pyletta-py3.10) $ letta run
|
||||
```
|
||||
|
||||
Alternatively, you can use `poetry run` (which will activate the `poetry` environment for the `memgpt run` command only):
|
||||
Alternatively, you can use `poetry run` (which will activate the `poetry` environment for the `letta run` command only):
|
||||
```shell
|
||||
poetry run memgpt run
|
||||
poetry run letta run
|
||||
```
|
||||
|
||||
**Installing dependencies with pip**:
|
||||
|
||||
First you should set up a dedicated virtual environment. This is optional, but is highly recommended:
|
||||
```shell
|
||||
cd MemGPT
|
||||
cd Letta
|
||||
python3 -m venv venv
|
||||
. venv/bin/activate
|
||||
```
|
||||
|
||||
Once you've activated your virtual environment and are in the MemGPT project directory, you can install the dependencies with `pip`:
|
||||
Once you've activated your virtual environment and are in the Letta project directory, you can install the dependencies with `pip`:
|
||||
```shell
|
||||
pip install -e '.[dev,postgres,local]'
|
||||
```
|
||||
|
||||
Now, you should be able to run `memgpt` from the command-line using the downloaded source code (if you used a virtual environment, you have to activate the virtual environment to access `memgpt`):
|
||||
Now, you should be able to run `letta` from the command-line using the downloaded source code (if you used a virtual environment, you have to activate the virtual environment to access `letta`):
|
||||
```shell
|
||||
$ . venv/bin/activate
|
||||
(venv) $ memgpt run
|
||||
(venv) $ letta run
|
||||
```
|
||||
|
||||
If you are having dependency issues using `pip`, we recommend you install the package using Poetry. Installing MemGPT from source using Poetry will ensure that you are using exact package versions that have been tested for the production build.
|
||||
If you are having dependency issues using `pip`, we recommend you install the package using Poetry. Installing Letta from source using Poetry will ensure that you are using exact package versions that have been tested for the production build.
|
||||
|
||||
#### (Optional) Installing pre-commit
|
||||
We recommend installing pre-commit to ensure proper formatting during development:
|
||||
@@ -106,7 +106,7 @@ pytest -s tests
|
||||
If you added a major feature change, please add new tests in the `tests/` directory.
|
||||
|
||||
## 4. 🧩 Adding new dependencies
|
||||
If you need to add a new dependency to MemGPT, please add the package via `poetry add <PACKAGE_NAME>`. This will update the `pyproject.toml` and `poetry.lock` files. If the dependency does not need to be installed by all users, make sure to mark the dependency as optional in the `pyproject.toml` file and if needed, create a new extra under `[tool.poetry.extras]`.
|
||||
If you need to add a new dependency to Letta, please add the package via `poetry add <PACKAGE_NAME>`. This will update the `pyproject.toml` and `poetry.lock` files. If the dependency does not need to be installed by all users, make sure to mark the dependency as optional in the `pyproject.toml` file and if needed, create a new extra under `[tool.poetry.extras]`.
|
||||
|
||||
## 5. 🚀 Submitting Changes
|
||||
|
||||
@@ -120,14 +120,14 @@ poetry run black . -l 140
|
||||
|
||||
You're almost there! It's time to share your brilliance with the world. 🌍
|
||||
|
||||
1. Visit [MemGPT](https://github.com/cpacker/memgpt).
|
||||
1. Visit [Letta](https://github.com/cpacker/letta).
|
||||
2. Click "New Pull Request" button.
|
||||
3. Choose the base branch (`main`) and the compare branch (your feature branch).
|
||||
4. Whip up a catchy title and describe your changes in the description. 🪄
|
||||
|
||||
## 6. 🔍 Review and Approval
|
||||
|
||||
The maintainers, will take a look and might suggest some cool upgrades or ask for more details. Once they give the thumbs up, your creation becomes part of MemGPT!
|
||||
The maintainers, will take a look and might suggest some cool upgrades or ask for more details. Once they give the thumbs up, your creation becomes part of Letta!
|
||||
|
||||
## 7. 📜 Code of Conduct
|
||||
|
||||
@@ -137,10 +137,10 @@ Please be sure to follow the project's Code of Conduct.
|
||||
|
||||
Need help or just want to say hi? We're here for you. Reach out through filing an issue on this GitHub repository or message us on our [Discord server](https://discord.gg/9GEQrxmVyE).
|
||||
|
||||
Thanks for making MemGPT even more fantastic!
|
||||
Thanks for making Letta even more fantastic!
|
||||
|
||||
## WIP - 🐋 Docker Development
|
||||
If you prefer to keep your resources isolated by developing purely in containers, you can start MemGPT in development with:
|
||||
If you prefer to keep your resources isolated by developing purely in containers, you can start Letta in development with:
|
||||
```shell
|
||||
docker compose -f compose.yaml -f development.compose.yml up
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user