Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add py 311 and 312-dev for CI #730

Merged
merged 1 commit into from
Aug 22, 2023
Merged

Add py 311 and 312-dev for CI #730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
matrix:
# "macos-latest" removed for now as Docker action is slow
os: [ "ubuntu-latest" ] # TODO: add "windows-latest"
python-version: ["3.8", "3.9", "3.10"]
python-version: ["3.8", "3.9", "3.10", "3.11"]
defaults:
run:
shell: bash
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test-deps.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
matrix:
# "macos-latest" removed for now as Docker action is slow
os: [ "ubuntu-latest" ] # TODO: add "windows-latest"
python-version: ["3.8", "3.9", "3.10"]
python-version: ["3.8", "3.9", "3.10", "3.11"]
defaults:
run:
shell: bash
Expand Down Expand Up @@ -46,7 +46,7 @@ jobs:
matrix:
# "macos-latest" removed for now as Docker action is slow
os: [ "ubuntu-latest" ] # TODO: add "windows-latest"
python-version: ["3.8", "3.9", "3.10"]
python-version: ["3.8", "3.9", "3.10", "3.11"]
defaults:
run:
shell: bash
Expand Down
49 changes: 22 additions & 27 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,25 @@ If you're new to open-source development, we recommend going through the GitHub
We follow something called a "fork and pull request" workflow for collaborating on our project. See [here](https://gist.github.com/Chaser324/ce0505fbed06b947d962) for a great overview on what some of these mysterious terms mean!

Once you've 'forked' and 'cloned' the code to your local machine, please follow these steps:

```shell
# Clone and change location directory of the superduperdb repository, change the `<FORKED_NAME>` to your GitHub id
git clone [email protected]:<FORKED_NAME>/superduperdb.git
cd superduperdb

# Create your Python virtual environment
python3 -m venv .venv

# Activate the Python virtual environment
. .venv/bin/activate
```
cd /path/to/superduperdb/root # change location to the root directory of the superduperdb repository
```
```
python3 -m venv .venv # create your Python virtual environment
```
```
. .venv/bin/activate # activate the Python virtual environment
```
```
python3 -m pip install --upgrade pip-tools # install pip-tools and latest version of pip
```
```
python3 -m pip install -e .[dev] # Install the superduperdb project in editable mode along with the developer tools

```shell
# 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 '.[dev]'
thejumpman2323 marked this conversation as resolved.
Show resolved Hide resolved
```

The final steps to creating a development environment involve installing [MongoDB](https://www.mongodb.com/docs/manual/installation/), [Docker](https://docs.docker.com/engine/install/) and [pandoc](https://pandoc.org/installing.html). Once you get this far, you are all set to start contributing - ship it! :shipit:
Expand All @@ -40,7 +45,7 @@ The final steps to creating a development environment involve installing [MongoD

### How do I update the `requirements` files for CI? :link:

1. Activate your [developer](#where-to-start-💥) environment.
1. Activate your [developer](#where-to-start--boom-) environment.
thejumpman2323 marked this conversation as resolved.
Show resolved Hide resolved
2. Run `. .github/ci-pinned-requirements/update-pinned-deps.sh`

### Why do we have so many `requirements` files for CI? :confused:
Expand All @@ -49,19 +54,9 @@ The short answer is so that we can create reproducible environments for our cont

## Getting Help 🙋

<a href="https://join.slack.com/t/superduperdb/shared_invite/zt-1zuojj0k0-RjAYBs1TDsvEa7yaFGa6QA" target="_blank">
<img src="https://img.shields.io/badge/Slack-superduperdb-8A2BE2?logo=slack" alt="Slack">
</a>

<a href="https://github.com/SuperDuperDB/superduperdb-stealth/issues" target="_blank">
<img src="https://img.shields.io/badge/Issues-superduperdb-8A2BE2?logo=github" alt="Issues">
</a>

<a href="https://github.com/SuperDuperDB/superduperdb-stealth/wiki" target="_blank">
<img src="https://img.shields.io/badge/Project%20Wiki-superduperdb-8A2BE2?logo=github" alt="Wiki">
</a>

[![Slack](https://img.shields.io/badge/Slack-superduperdb-8A2BE2?logo=slack)](https://join.slack.com/t/superduperdb/shared_invite/zt-1zuojj0k0-RjAYBs1TDsvEa7yaFGa6QA)
thejumpman2323 marked this conversation as resolved.
Show resolved Hide resolved
[![Issues](https://img.shields.io/badge/Issues-superduperdb-8A2BE2?logo=github)](https://github.com/SuperDuperDB/superduperdb-stealth/issues)
[![Wiki](https://img.shields.io/badge/Project%20Wiki-superduperdb-8A2BE2?logo=github)](https://github.com/SuperDuperDB/superduperdb-stealth/wiki)

If you have any problems please contact a maintainer or community volunteer. The GitHub issues or the Slack channel are a great place to start. We look forward to seeing you there! :purple_heart:


3 changes: 2 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ classifiers = [
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: Implementation :: CPython",
"Topic :: Database",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
Expand All @@ -50,7 +51,7 @@ dependencies = [
"flask-cors>=3.0.10",
"flask-httpauth>=4.7.0",
"werkzeug>=2.2.3",
"pydantic >=1",
"pydantic>=1",
"pymongo>=4.3.3",
"numpy>=1.24.3",
"overrides>=7",
Expand Down