SuperDuperDB / superduperdb

🔮 SuperDuperDB: Bring AI to your database! Build, deploy and manage any AI application directly with your existing data infrastructure, without moving your data. Including streaming inference, scalable model training and vector search.
https://superduperdb.com
Apache License 2.0
4.55k stars 445 forks source link

[DOC]: Missing DevKit installation in CONTRIBUTING file #2134

Closed klepp0 closed 1 month ago

klepp0 commented 1 month ago

What's wrong?

Following the CONTRIBUTING.md fails when trying to execute make unit_testing:

  1. Get the code on your local:
# Clone and change location directory of the superduperdb repository, change the `<FORKED_NAME>` to your GitHub id
git clone git@github.com:<FORKED_NAME>/superduperdb.git
cd superduperdb
  1. Set up your python environment:
# Create your Python virtual environment
python3 -m venv .venv

# Activate the Python virtual environment
. .venv/bin/activate  
  1. Install the dependencies:
# Install pip-tools and latest version of pip
python3 -m pip install --upgrade pip-tools

# Install the superduperdb project in editable mode along with the developer tools
python3 -m pip install -e '.'
python3 -m pip install -r deploy/installations/testenv_requirements.txt
  1. Run unit tests:
$ make unit_testing
pytest  ./test/unittest/
make: pytest: No such file or directory
make: *** [unit_testing] Error 1

How could it be better?

Including the make install_devkit command in the setup instructions would ensure a smoother setup and ensure more consistent development environments 🙂🚀

blythed commented 1 month ago

Thanks for pointing out - have you seen this in the .github/ci_code.yml workflow? We have missed make install_devkit.

klepp0 commented 1 month ago

Good point, I didn't go deeper than the contribution file yet. I guess I used the wrong template then.