added uv and pnpm, updated readme #47

vasilmax · 2025-06-11T20:38:41Z

Description

Updated the project to use the uv package package manager and its toolset to install python
Updated the project to use the pnpm package manager and its toolset to install node
Added docker for postgresql and redis

Fixes # (link issue)

Type of change

Updated README.md
Added docker-compose.yml

d33bs

Nice job - cool to see this added. I left a few comments for your consideration. Please don't hesitate to let me know if you have any questions.

d33bs · 2025-06-12T12:16:23Z

README.md

- 4.  **PostgreSQL:** A running PostgreSQL database server (version 12+ recommended). You'll need the ability to create a database and a user. [Download PostgreSQL](https://www.postgresql.org/download/)
- 5.  **Redis:** A running Redis server. Celery uses this to manage background tasks. [Download Redis](https://redis.io/docs/getting-started/installation/) or use Docker.
-+6.  **Node.js and npm:** For running the frontend application. Npm usually comes bundled with Node.js. [Download Node.js](https://nodejs.org/) (LTS version recommended). You can check your installation by running `node -v` and `npm -v` in your terminal.
+ 1. **Python:** Version 3.13 or higher. [Download Python](https://www.python.org/downloads/)


Do we need to download Python (would uv do this for us automatically)?

Nope, uv can manage install and manage python versions with uv install python 3.13 . This should be done after creating and activating the environment. You can use uv python list to see what's installed and available.

d33bs · 2025-06-12T12:18:52Z

README.md

+    Use uv to install setup virtual environment.
+
+    ```sh
+    uv python install 3.13 # Install python 


Do we need to explicitly install a Python version (would uv select and install for us)?

I imagine if you have python already installed system-wide, the venv uv creates would just use that. However after many broken system configs, I avoid installing python directly and let uv manage it entirely. This also avoids some puzzling errors I've encountered which I now believe were caused by conflicts with the build-in pip that's installed with the official python installer.

Jon originally used 3.10, but running through with 3.13 alongside updating the libraries seemed to work.

That is a great point though! I'll update the readme to better detail installation of python with uv. Do you think a .python-version file would help? As outputted by uv python pin

d33bs · 2025-06-12T12:20:19Z

README.md

+    * **On macOS/Linux:**
+
+        ```sh
+        source .venv/bin/activate


Would it be possible to avoid this step by using uv run when necessary?

You're right, using uv run should walk up the directory path until it finds a pyproject.toml, and is simpler. I'll remove the second pyproject.toml here /MOSS/Older Experiments/pyproject.toml .

You're right, uv commands walk up the path tree until they hit a pyproject.toml , so it should work. I'll rename the other one at ./MOSS/Older Experiments/pyproject.toml just in case.

d33bs · 2025-06-12T12:21:13Z

README.md

+    Install all the required Python packages listed in `pyproject.toml`:
+
+    ```sh
+    uv sync


Consider removing as this step is typically automatic when using uv.

Yea ok. Would it makes sense to split the readme into 2 sections? One for just getting the project running, and the other for developing.

Yea ok. Would it makes sense to split the readme into 2 sections? One for just getting the project running, and the other for developing.

I agree with this sentiment but the change should probably be done in a separate pr. this one is already quite long

d33bs · 2025-06-12T12:25:01Z

README.md

+1. **Terminal 1:** Backend API Server (`uvicorn backend.main:app ...`)
+2. **Terminal 2:** Celery Worker (`celery -A backend.celery_app worker ...`)
+3. **Terminal 3:** Frontend Development Server (`cd frontend && npm run dev`)


There's probably an opportunity to improve this by making the code here a run.sh script (we have almost as much code as we do natural language in these lines). Depending on how you feel you could possibly add that to this PR or we could bump this into a new issue and work on it later.

I too considered wrapping that in a script for this PR, but I wasn't sure whether to do it with a script and have different OS to consider/test, or add it to docker as well..

There is also the option of specifying it in pyproject.toml, which may be cleaner and closer aligned to a standardized approach. Here for instance, where they use taskipy task runner to start the rest (ex. https://github.com/leosussan/fastapi-gino-arq-uvicorn/blob/master/pyproject.toml)

I used poethepoet like you suggested, and it did work. However, the solution uses Shell tasks, as it seems parallel execution support is an open problem nat-n/poethepoet#24

My concern is this note in the docs:
By default poe attempts to find a posix shell (sh, bash, or zsh in that order) on the system and uses that. When running on windows, poe will first look for [git bash](https://gitforwindows.org/) at the usual location, and otherwise attempt to find it via the PATH, though this might not always be possible.

d33bs · 2025-06-12T12:32:00Z

docker-compose.yml

@@ -0,0 +1,27 @@
+services:


Consider adding a comment to the top of the file to help describe what it does. We have that information within the readme but oftentimes when in development we are deep in the weeds of individual files, where it can help to have notes so as to not go searching for meaning elsewhere.

Okay, will do.

Seeing that you added this in - great!

d33bs · 2025-06-12T12:34:25Z

frontend/package.json

This comment is outside the bounds of this PR's focus. It might be a good idea for us to consider using Dependabot to help maintain the environment specifications for this project over time (esp. for Node and Python dependencies). uv-style pyproject.toml files aren't yet supported but likely will be in the future.

using Dependabot is a great idea! we should create an issue for this so it doesn't get forgotten.

Cheers - let's add this in for later work: #48

d33bs · 2025-06-12T12:35:27Z

main.py

This looks like it might have been a test file. Consider removing if we don't need it any longer. If we do still need it, consider placing in a source code directory where appropriate.

I think this is actually the default file that is created with uv init . The backend shouldn't serve that though, so we can remove it. Towards production we should add a 404 page and look into locking down the backend.

Seeing that this was removed - nice, thanks for addressing this!

d33bs · 2025-06-12T12:43:31Z

README.md


-## Frontend Setup and Running
+    ```sh
+    ur run uvicorn backend.main:app --reload --host 0.0.0.0 --port 8000


Suggested change

ur run uvicorn backend.main:app --reload --host 0.0.0.0 --port 8000

uv run uvicorn backend.main:app --reload --host 0.0.0.0 --port 8000

d33bs · 2025-06-12T12:57:46Z

README.md

-    npm run dev
+
+    ```sh
+    pnpm dev


When trying to run this I ran into the error: ERROR packages field missing or empty. It's possible I did something wrong but I wanted to bring it up just in case there's a need to update the pnpm-workspace.yaml or similar.

I added the packages field, so hopefully that helps. Let me know!

README.md

d33bs · 2025-07-05T19:36:08Z

Hi @vasilmax - just wanted to double check, is this ready for another review? If so, feel free to respond here or re-request a review using the "reviewers" pane in the top right of the GitHub PR web interface. Please also don't hesitate to let me know if I can follow up on anything in particular before that point.

vasilmax · 2025-07-07T13:05:02Z

Hi @vasilmax - just wanted to double check, is this ready for another review? If so, feel free to respond here or re-request a review using the "reviewers" pane in the top right of the GitHub PR web interface. Please also don't hesitate to let me know if I can follow up on anything in particular before that point.

Hi @d33bs, thanks for following up! I was preoccupied over the weekend but did start on the changes last night. I will make a commit with the updates by eod today and will re-request your review once I push. Really appreciate your knowledge and expertise!

README.md

df0o · 2025-07-08T01:14:36Z

just some minor changes to the readme, otherwise looks good to me. i tried following through the setup process and it runs no issues for me 👍

df0o

lgtm 👍

d33bs

Excellent work @vasilmax !

d33bs · 2025-07-17T15:25:21Z

docker-compose.yml

Thanks - looks like these errors and warnings no longer appear!

d33bs · 2025-07-17T15:25:36Z

docker-compose.yml

@@ -0,0 +1,27 @@
+services:


Seeing that you added this in - great!

d33bs · 2025-07-17T15:27:27Z

frontend/package.json

Cheers - let's add this in for later work: #48

d33bs · 2025-07-17T15:28:00Z

main.py

Seeing that this was removed - nice, thanks for addressing this!

d33bs · 2025-07-17T15:31:48Z

pyproject.toml

 requires-python = ">=3.13"
+license = { text = "Apache-2.0" }
+authors = [
+    { name = "The MOSS Authors", email = "[email protected]" },


Just double checking here: will Jon be the coordinating author for all on this project? As-is, that's how this entry into the authors field looks. I think we can also subtract the email value, leaving this a bit more vague in terms of who to contact (perhaps that should be the repository, openly?).

Yea that's a great suggestion! I'll open an issue regarding the author's field and its format so we can discuss at the next meeting.

d33bs · 2025-07-17T15:32:17Z

pyproject.toml

+    "python-louvain>=0.16",
+]
+
+[tool.poe.tasks]


Nice! In testing all of these I found they worked beautifully, great job!

added uv and pnpm, updated readme

e60e418

d33bs self-requested a review June 11, 2025 20:42

d33bs reviewed Jun 12, 2025

View reviewed changes

df0o reviewed Jun 14, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

vasilmax added 2 commits July 7, 2025 20:08

updates on PR comments

06648a8

updates on PR comments

cca1d32

df0o reviewed Jul 8, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

df0o reviewed Jul 8, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

df0o reviewed Jul 8, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

new token link, add docker install link, fix overview

c9fe76a

vasilmax requested review from d33bs and df0o July 8, 2025 14:53

vasilmax added 6 commits July 8, 2025 11:12

add docker-compose.yml comment

0dece64

added lock files, removed .python-version from .gitignore

f8159cb

added packages param to pnpm-workspace.yaml

66aebe8

fixed docker lint warnings

54279c2

removed pnpm lock file

f368a7b

readded reactflow

c5808ad

vasilmax marked this pull request as ready for review July 8, 2025 23:18

df0o approved these changes Jul 16, 2025

View reviewed changes

d33bs mentioned this pull request Jul 17, 2025

Add Dependabot to help increase sustainability of project dependencies #48

Open

d33bs approved these changes Jul 17, 2025

View reviewed changes

d33bs mentioned this pull request Jul 17, 2025

Browser darkmode color contrast may need adjustments #49

Open

vasilmax merged commit 015b093 into main Jul 27, 2025

	ur run uvicorn backend.main:app --reload --host 0.0.0.0 --port 8000
	uv run uvicorn backend.main:app --reload --host 0.0.0.0 --port 8000

Uh oh!

added uv and pnpm, updated readme #47

added uv and pnpm, updated readme #47

Uh oh!

Conversation

vasilmax commented Jun 11, 2025

Description

Fixes # (link issue)

Type of change

Uh oh!

d33bs left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

d33bs commented Jul 5, 2025

Uh oh!

vasilmax commented Jul 7, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

df0o commented Jul 8, 2025

Uh oh!

df0o left a comment

Choose a reason for hiding this comment

Uh oh!

d33bs left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment