76 lines
2.9 KiB
Markdown
76 lines
2.9 KiB
Markdown
---
|
|
title: Contributing to the codebase
|
|
excerpt: How to modify code and create pull requests
|
|
category: 6581eaa89a00e6001012822c
|
|
---
|
|
|
|
If you plan on making big changes to the codebase, the easiest way to make contributions is to install MemGPT directly from the source code (instead of via `pypi`, which you do with `pip install ...`).
|
|
|
|
Once you have a working copy of the source code, you should be able to modify the MemGPT codebase an immediately see any changes you make to the codebase change the way the `memgpt` command works! Then once you make a change you're happy with, you can open a pull request to get your changes merged into the official MemGPT package.
|
|
|
|
> 📘 Instructions on installing from a fork and opening pull requests
|
|
>
|
|
> If you plan on contributing your changes, you should create a fork of the MemGPT repo and install the source code from your fork.
|
|
>
|
|
> Please see [our contributing guide](https://github.com/cpacker/MemGPT/blob/main/CONTRIBUTING.md) for instructions on how to install from a fork and open a PR.
|
|
|
|
## Installing MemGPT from source
|
|
|
|
**Reminder**: if you plan on opening a pull request to contribute your changes, follow our [contributing guide's install instructions](https://github.com/cpacker/MemGPT/blob/main/CONTRIBUTING.md) instead!
|
|
|
|
To install MemGPT from source, start by cloning the repo:
|
|
|
|
```sh
|
|
git clone git@github.com:cpacker/MemGPT.git
|
|
```
|
|
|
|
### Installing dependencies with poetry (recommended)
|
|
|
|
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:
|
|
|
|
```sh
|
|
cd MemGPT
|
|
poetry install --all-extras
|
|
poetry shell
|
|
```
|
|
|
|
Now when you want to use `memgpt`, make sure you first activate the `poetry` environment using poetry shell:
|
|
|
|
```sh
|
|
$ poetry shell
|
|
(pymemgpt-py3.10) $ memgpt run
|
|
```
|
|
|
|
Alternatively, you can use `poetry run` (which will activate the `poetry` environment for the `memgpt run` command only):
|
|
|
|
```sh
|
|
poetry run memgpt run
|
|
```
|
|
|
|
### Installing dependencies with pip
|
|
|
|
First you should set up a dedicated virtual environment. This is optional, but is highly recommended:
|
|
|
|
```sh
|
|
cd MemGPT
|
|
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`:
|
|
|
|
```sh
|
|
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`):
|
|
|
|
```sh
|
|
$ . venv/bin/activate
|
|
(venv) $ memgpt 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.
|