Skip to content

Commit bf27d1d

Browse files
committed
Add an installation script
1 parent fc10d19 commit bf27d1d

File tree

16 files changed

+2131
-13
lines changed

16 files changed

+2131
-13
lines changed

.github/workflows/build-python.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Reusable GitHub Actions workflow for building Python packages
2+
3+
name: Build python package
4+
5+
on:
6+
workflow_call:
7+
inputs:
8+
python-version:
9+
description: 'Python version'
10+
required: false
11+
type: string
12+
default: '3.x'
13+
patch-version:
14+
description: 'Version to patch into pyproject.toml'
15+
required: false
16+
type: string
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout repo
23+
uses: actions/checkout@v4
24+
25+
- name: Set up Python ${{ inputs.python-version }}
26+
uses: actions/setup-python@v5
27+
with:
28+
python-version: ${{ inputs.python-version }}
29+
30+
- name: Patch version in pyproject.toml
31+
if: inputs.patch-version != ''
32+
run: |
33+
VERSION="${{ inputs.patch-version }}"
34+
echo "Updating pyproject.toml version to $VERSION"
35+
sed -i -E "s/^version = \".*\"/version = \"$VERSION\"/" pyproject.toml
36+
37+
- name: Install dependencies and uv
38+
run: |
39+
python -m pip install --upgrade pip
40+
pip install --upgrade build
41+
pip install uv
42+
43+
- name: Build the package with uv
44+
run: |
45+
uv build
46+
ls -lh dist/
47+
48+
- name: Upload built distributions as artifact
49+
uses: actions/upload-artifact@v4
50+
with:
51+
name: python-package-dist
52+
path: dist/*
Lines changed: 309 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,309 @@
1+
# .github/workflows/windows-test.yml
2+
3+
name: Installation Test
4+
5+
# on:
6+
# push:
7+
# branches: [ main ]
8+
# pull_request:
9+
# branches: [ main ]
10+
on:
11+
push:
12+
branches:
13+
- installation-script-2
14+
15+
jobs:
16+
build:
17+
uses: ./.github/workflows/build-python.yml
18+
with:
19+
python-version: "3.12"
20+
21+
check-linux:
22+
needs: build
23+
runs-on: ubuntu-latest
24+
25+
services:
26+
postgres:
27+
image: pgvector/pgvector:pg16
28+
env:
29+
POSTGRES_USER: memmachine
30+
POSTGRES_PASSWORD: mammachine_password
31+
POSTGRES_DB: memmachine
32+
POSTGRES_INITDB_ARGS: "--encoding=UTF-8 --lc-collate=C --lc-ctype=C"
33+
ports:
34+
- 5432:5432
35+
options: >-
36+
--health-cmd="pg_isready -U memmachine"
37+
--health-interval=10s
38+
--health-timeout=5s
39+
--health-retries=5
40+
41+
ollama:
42+
image: ollama/ollama
43+
ports:
44+
- 11434:11434
45+
46+
steps:
47+
- name: Set up Python 3.12
48+
uses: actions/setup-python@v5
49+
with:
50+
python-version: "3.12"
51+
52+
- name: Download built distributions
53+
uses: actions/download-artifact@v4
54+
with:
55+
name: python-package-dist
56+
57+
- name: Set up ollama
58+
run: |
59+
set -eo pipefail
60+
until curl -s http://localhost:11434/ > /dev/null; do
61+
echo "Ollama not up yet, sleeping..."
62+
sleep 1
63+
done
64+
65+
echo "Ollama is up, loading model..."
66+
curl http://localhost:11434/api/pull -d '{
67+
"name": "qwen3:0.6b"
68+
}' -v
69+
echo "pulled model qwen3:0.6b into ollama"
70+
71+
curl http://localhost:11434/api/pull -d '{
72+
"name": "nomic-embed-text"
73+
}' -v
74+
echo "pulled model nomic-embed-text into ollama"
75+
76+
- name: Test install on Ubuntu
77+
run: |
78+
set -eo pipefail
79+
whl_name=$(ls *.whl)
80+
echo "Installing wheel file: $whl_name"
81+
python -m pip install $whl_name
82+
echo "configuring memmachine"
83+
memmachine-configure << EOF
84+
y
85+
CPU
86+
Ollama
87+
qwen3:0.6b
88+
nomic-embed-text
89+
localhost
90+
5432
91+
memmachine
92+
mammachine_password
93+
memmachine
94+
http://localhost:11434/v1
95+
localhost
96+
8080
97+
EOF
98+
99+
memmachine-nltk-setup
100+
memmachine-sync-profile-schema
101+
102+
memmachine-server &
103+
server_pid=$!
104+
sleep 5
105+
106+
curl -f http://127.0.0.1:8080/v1/sessions
107+
108+
shell: bash
109+
110+
check-windows:
111+
needs: build
112+
runs-on: windows-latest
113+
114+
steps:
115+
- name: Setup Miniconda
116+
uses: conda-incubator/setup-miniconda@v3
117+
with:
118+
python-version: 3.12
119+
auto-update-conda: true
120+
121+
- name: Download built distributions
122+
uses: actions/download-artifact@v4
123+
with:
124+
name: python-package-dist
125+
126+
- name: Verify Python Version
127+
run: |
128+
Write-Host "Verifying Python installation... location: {where python}"
129+
python --version
130+
conda --version
131+
exit 1
132+
133+
- name: set up dev tools
134+
uses: ilammy/msvc-dev-cmd@v1
135+
136+
- name: install postgresql
137+
run: |
138+
conda install postgresql
139+
140+
echo "Cloning pgvector..."
141+
git clone https://github.com/pgvector/pgvector.git
142+
cd pgvector
143+
144+
echo "Building and installing pgvector..."
145+
$env:PGROOT = "$($env:CONDA_PREFIX)\Library"
146+
echo "PGROOT set to: $env:PGROOT"
147+
148+
nmake /NOLOGO /F Makefile.win
149+
if ($LastExitCode -ne 0) { throw "nmake build failed!" }
150+
nmake /NOLOGO /F Makefile.win install
151+
if ($LastExitCode -ne 0) { throw "nmake install failed!" }
152+
153+
echo "Build and install complete."
154+
cd ..
155+
156+
initdb -D postgres_data --encoding=UTF-8 --lc-collate=C --lc-ctype=C
157+
pg_ctl -D postgres_data -o "-F" -l logfile start
158+
createuser -U runneradmin -s memmachine
159+
createdb -U runneradmin -O memmachine memmachine
160+
psql -U runneradmin -d postgres -c "ALTER USER memmachine WITH PASSWORD 'mammachine_password';"
161+
psql -d memmachine -U memmachine -c "CREATE EXTENSION IF NOT EXISTS vector;"
162+
163+
- name: Set up ollama
164+
shell: bash
165+
run: |
166+
set -eo pipefail
167+
winget install Ollama.Ollama --accept-source-agreements
168+
169+
until curl -s http://localhost:11434/ > /dev/null; do
170+
echo "Ollama not up yet, sleeping..."
171+
sleep 1
172+
done
173+
174+
echo "Ollama is up, loading model..."
175+
curl http://localhost:11434/api/pull -d '{
176+
"name": "qwen3:0.6b"
177+
}' -v
178+
echo "pulled model qwen3:0.6b into ollama"
179+
180+
curl http://localhost:11434/api/pull -d '{
181+
"name": "nomic-embed-text"
182+
}' -v
183+
echo "pulled model nomic-embed-text into ollama"
184+
185+
- name: Test install on Windows
186+
run: |
187+
set -eo pipefail
188+
export PYTHONUTF8=1
189+
whl_name=$(ls *.whl)
190+
echo "Installing wheel file: $whl_name"
191+
python -m pip install $whl_name
192+
echo "configuring memmachine"
193+
memmachine-configure << EOF
194+
y
195+
196+
CPU
197+
Ollama
198+
qwen3:0.6b
199+
nomic-embed-text
200+
localhost
201+
5432
202+
memmachine
203+
mammachine_password
204+
memmachine
205+
http://localhost:11434/v1
206+
localhost
207+
8080
208+
EOF
209+
210+
python -c "import nltk; nltk.download('punkt')"
211+
memmachine-nltk-setup
212+
memmachine-sync-profile-schema
213+
214+
memmachine-server &
215+
server_pid=$!
216+
sleep 5
217+
218+
curl -f http://127.0.0.1:8080/v1/sessions
219+
220+
shell: bash
221+
222+
check-macos:
223+
needs: build
224+
runs-on: macos-latest
225+
226+
steps:
227+
- name: Set up Python 3.12
228+
uses: actions/setup-python@v5
229+
with:
230+
python-version: "3.12"
231+
232+
- name: Download built distributions
233+
uses: actions/download-artifact@v4
234+
with:
235+
name: python-package-dist
236+
237+
- name: Set up postgresql (pgvector) using Homebrew
238+
run: |
239+
set -eo pipefail
240+
brew update
241+
brew upgrade
242+
243+
brew install postgresql@18
244+
brew install pgvector
245+
rm -rf /opt/homebrew/var/postgresql@18
246+
"/opt/homebrew/opt/postgresql@18/bin/initdb" -D /opt/homebrew/var/postgresql@18 --encoding=UTF-8 --lc-collate=C --lc-ctype=C
247+
brew services start postgresql@18
248+
249+
export PATH="/opt/homebrew/opt/postgresql@18/bin:$PATH"
250+
while ! pg_isready -q; do
251+
sleep 1
252+
done
253+
254+
createuser -s memmachine
255+
createdb -O memmachine memmachine
256+
psql -d postgres -c "ALTER USER memmachine WITH PASSWORD 'mammachine_password';"
257+
psql -d memmachine -U memmachine -c "CREATE EXTENSION IF NOT EXISTS vector;"
258+
259+
- name: Set up ollama
260+
run: |
261+
set -eo pipefail
262+
brew install ollama
263+
brew services start ollama
264+
until curl -s http://localhost:11434/ > /dev/null; do
265+
echo "Ollama not up yet, sleeping..."
266+
sleep 1
267+
done
268+
269+
echo "Ollama is up, loading model..."
270+
curl http://localhost:11434/api/pull -d '{
271+
"name": "qwen3:0.6b"
272+
}' -v
273+
echo "pulled model qwen3:0.6b into ollama"
274+
275+
curl http://localhost:11434/api/pull -d '{
276+
"name": "nomic-embed-text"
277+
}' -v
278+
echo "pulled model nomic-embed-text into ollama"
279+
280+
- name: Test install on macOS
281+
run: |
282+
set -eo pipefail
283+
whl_name=$(ls *.whl)
284+
echo "Installing wheel file: $whl_name"
285+
python -m pip install $whl_name
286+
echo "configuring memmachine"
287+
memmachine-configure << EOF
288+
y
289+
CPU
290+
OpenAI
291+
gpt-4o-mini
292+
text-embedding-3-small
293+
localhost
294+
5432
295+
memmachine
296+
mammachine_password
297+
memmachine
298+
sk-test
299+
localhost
300+
8080
301+
EOF
302+
memmachine-nltk-setup
303+
memmachine-sync-profile-schema
304+
305+
memmachine-server &
306+
server_pid=$!
307+
sleep 5
308+
curl -f http://127.0.0.1:8080/v1/sessions
309+
shell: bash

DOCKER_COMPOSE_README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@
99
### 1. Configure Environment
1010
Copy the example environment file and add your OpenAI API key:
1111
```bash
12-
cp sample_configs/env.dockercompose .env
12+
cp src/memmachine/sample_configs/env.dockercompose .env
1313
# Edit .env and add your OPENAI_API_KEY
1414
```
1515

1616
### 2. Configure MemMachine
1717
Copy the sample configuration file and update it with your settings:
1818
```bash
19-
cp sample_configs/episodic_memory_config.sample configuration.yml
19+
cp src/memmachine/sample_configs/episodic_memory_config.sample configuration.yml
2020
# Edit configuration.yml and update:
2121
# - Replace <YOUR_API_KEY> with your OpenAI API key
2222
# - Replace <YOUR_PASSWORD_HERE> with your Neo4j password

0 commit comments

Comments
 (0)