Merge pull request #189 from roboflow/devcontainer

Add devcontainer

Author: tonylampada

.devcontainer/bashrc_ext

@@ -0,0 +1,19 @@
+parse_git_branch() {
+     git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/ (\1)/'
+}
+export PS1="\[\033[32m\]\w\[\033[33m\]\$(parse_git_branch)\[\033[00m\] $ "
+alias ll='ls -lah'
+source /usr/share/bash-completion/completions/git
+
+#!/bin/bash
+RESTORE='\033[0m'
+RED='\033[00;31m'
+GREEN='\033[00;32m'
+YELLOW='\e[0;33m'
+
+function quickstart {
+    echo -e ""
+    echo -e "${RED}run tests${RESTORE}"
+    echo -e "${YELLOW}python -m unittest${RESTORE}"
+    echo -e ""
+}

.devcontainer/devcontainer.json

@@ -0,0 +1,18 @@
+{
+    "name": "roboflow-python devcontainer",
+    "dockerComposeFile": "./docker-compose.yaml",
+    "service": "devcontainer-roboflow-python",
+    "workspaceFolder": "/roboflow-python",
+    "postStartCommand": "git config --global --add safe.directory ${containerWorkspaceFolder}",
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "ms-python.python",
+                "ms-python.black-formatter"
+            ],
+            "settings": {
+                "extensions.verifySignature": false
+            }
+        }
+    }
+}

.devcontainer/docker-compose.yaml

@@ -0,0 +1,10 @@
+version: '3'
+services:
+  devcontainer-roboflow-python:
+    build:
+      context: ..
+      dockerfile: Dockerfile.dev
+    image: devcontainer-roboflow-python
+    volumes:
+      - ..:/roboflow-python
+    command: sleep infinity

.vscode/settings.json

@@ -0,0 +1,18 @@
+{
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "./tests",
+        "-p",
+        "test_*.py"
+    ],
+    "python.testing.unittestEnabled": true,
+    "python.testing.pytestArgs": [
+        "."
+    ],
+    "editor.formatOnSave": true,
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter"
+    },
+    "python.formatting.provider": "none"
+}

CONTRIBUTING.md

@@ -37,4 +37,6 @@ make style
 make check_code_quality
 ```
 
-**Note** These tests will be run automatically when you commit thanks to git hooks.
+**Note** These tests will be run automatically when you commit thanks to git hooks.
+
+**Note** This project also comes with a [convenient devcontainer](https://www.loom.com/share/a183c4a351ed4700a79476fedf08ab9b) that makes it easier to run tests and has black configured to run on save.

Dockerfile.dev

@@ -1,7 +1,9 @@
-ARG PYTHON_VERSION=3.8
-FROM python:$PYTHON_VERSION-slim
-RUN apt-get update && apt-get install make && rm -rf /var/lib/apt/lists/*
-WORKDIR /workspace
-COPY . .
+FROM python:3.8
+RUN apt-get update && apt-get install -y make libgl1-mesa-glx && rm -rf /var/lib/apt/lists/*
+WORKDIR /roboflow-python
+COPY .devcontainer/bashrc_ext /root/bashrc_ext
+RUN echo "source /root/bashrc_ext" >> ~/.bashrc
+COPY ./setup.py ./pyproject.toml ./README.md ./requirements.txt ./
+COPY roboflow/__init__.py ./roboflow/__init__.py
 RUN pip install -e ".[dev]"
-ENTRYPOINT [ "/bin/bash" ]
+COPY . .

README.md

@@ -152,7 +152,7 @@ Within the version object, you can download the dataset version in any model for
 
 ## 🏆 Contributing
 
-We would love your input on how we can improve the Roboflow Python package! Please see our [contributing guide](https://github.com/roboflow/roboflow-python) to get started. Thank you 🙏 to all our contributors!
+We would love your input on how we can improve the Roboflow Python package! Please see our [contributing guide](./CONTRIBUTING.md) to get started. Thank you 🙏 to all our contributors!
 
 <br>