Devenv (#25)

* moving to devcontainer

* attempt at github actions

Author: Carl Sverre

.devcontainer/Dockerfile

@@ -0,0 +1,19 @@
+# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster
+ARG VARIANT=3-bullseye
+FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
+
+ENV PYTHONUNBUFFERED 1
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] If your requirements rarely change, uncomment this section to add them to the image.
+# COPY requirements.txt /tmp/pip-tmp/
+# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \
+#    && rm -rf /tmp/pip-tmp
+
+# [Optional] Uncomment this section to install additional OS packages.
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    && apt-get -y install --no-install-recommends mariadb-client
+

.devcontainer/devcontainer.json

@@ -0,0 +1,39 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.224.3/containers/python-3-postgres
+// Update the VARIANT arg in docker-compose.yml to pick a Python version
+{
+  "name": "Python 3 & PostgreSQL",
+  "dockerComposeFile": "docker-compose.yml",
+  "service": "app",
+  "workspaceFolder": "/workspace",
+
+  // Set *default* container specific settings.json values on container create.
+  "settings": {
+    "python.defaultInterpreterPath": "/usr/local/bin/python",
+    "python.linting.enabled": true,
+    "python.linting.flake8Enabled": true,
+    "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+    "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+    "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+    "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+    "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+    "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+    "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+    "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+    "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint",
+    "python.testing.pytestPath": "/usr/local/py-utils/bin/pytest"
+  },
+
+  // Add the IDs of extensions you want installed when the container is created.
+  "extensions": ["ms-python.python", "ms-python.vscode-pylance"],
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // This can be used to network with other containers or the host.
+  // "forwardPorts": [5000, 5432],
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "pip install . && pip install twine pytest",
+
+  // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+  "remoteUser": "vscode"
+}

.devcontainer/docker-compose.yml

@@ -0,0 +1,37 @@
+version: "3.8"
+
+services:
+  app:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+      args:
+        # Update 'VARIANT' to pick a version of Python: 3, 3.10, 3.9, 3.8, 3.7, 3.6
+        # Append -bullseye or -buster to pin to an OS version.
+        # Use -bullseye variants on local arm64/Apple Silicon.
+        VARIANT: 3.6-buster
+        # Optional Node.js version to install
+        NODE_VERSION: "none"
+
+    volumes:
+      - ..:/workspace:cached
+
+    # Overrides default command so things don't shut down after the process ends.
+    command: sleep infinity
+
+    environment:
+      - MEMSQL_PYTHON_TEST_HOST=db
+
+    # Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.
+    network_mode: service:db
+    # Uncomment the next line to use a non-root user for all processes.
+    # user: vscode
+
+  db:
+    image: mysql:5.7.37
+    restart: unless-stopped
+    environment:
+      MYSQL_ROOT_PASSWORD: mysql
+
+volumes:
+  postgres-data: null

.flake8

@@ -1,3 +1,3 @@
 [flake8]
-exclude: .git,__pycache__,*.pyc,venv,venv2.7,venv3.4,distribution
+exclude: .git,__pycache__,*.pyc,venv,venv2.7,venv3.4,distribution,.eggs
 ignore: E121,E128,E201,E202,E221,E222,E241,E302,E4,E5,E305

.github/workflows/all.yml

@@ -0,0 +1,29 @@
+name: Test
+
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    services:
+      mysql:
+        image: mysql:5.7.37
+        env:
+          MYSQL_ROOT_PASSWORD: mysql
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.6
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install flake8 pytest
+          pip install .
+      - name: Run tests
+        env:
+          MEMSQL_PYTHON_TEST_HOST: mysql
+        run: |
+          make test

.travis.yml

@@ -1,2 +1,2 @@
 include *.txt
-include *.rst
+include *.md

MANIFEST.in

@@ -19,8 +19,4 @@ test-watch:
 
 .PHONY: flake8
 flake8:
-	flake8 --config=.flake8 .
-
-.PHONY: shell
-shell:
-	nix-shell -A memsqlPython
+	flake8 --config=.flake8 .

Makefile

@@ -0,0 +1,31 @@
+# MemSQL Python Libraries
+
+This library contains various plugins and wrappers designed by MemSQL
+engineers for a couple of important python libraries.
+
+## Install
+
+```bash
+pip install memsql
+```
+
+Copy and paste the following steps to get started quickly on Ubuntu:
+
+```bash
+sudo apt-get update
+sudo apt-get install -y mysql-client python-dev libmysqlclient-dev python-pip
+sudo pip install memsql
+```
+
+Copy and paste the following to get
+started with RHEL based distributions such as Amazon Linux or Centos:
+
+```bash
+sudo yum update
+sudo yum install -y gcc mysql-devel
+sudo pip install memsql
+```
+
+## Testing
+
+Run tests by executing `make test`.

README.md

@@ -1,6 +1,6 @@
+import os
 import pytest
 from memsql.common import database
-import os
 
 host = os.environ.get('MEMSQL_PYTHON_TEST_HOST', '127.0.0.1')
 
@@ -14,7 +14,7 @@ def test_db_args():
         "host": host,
         "port": 3306,
         "user": 'root',
-        "password": ''
+        "password": 'mysql'
     }
 
 @pytest.fixture

README.rst

@@ -6,13 +6,17 @@
 # get version
 from memsql import __version__
 
-import sys
+from pathlib import Path
+
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
+
 
 REQUIREMENTS = [
     'wraptor',
     'simplejson',
     'python-dateutil<3.0',
-    'mysqlclient>=1.4',
+    'mysqlclient<2.0',
 ]
 
 class PyTest(TestCommand):
@@ -86,7 +90,8 @@ def run_tests(self):
     url='http://github.com/memsql/memsql-python',
     license='LICENSE.txt',
     description='Useful utilities and plugins for MemSQL integration.',
-    long_description=open('README.rst').read(),
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     classifiers=[
         'License :: OSI Approved :: MIT License',
         'Programming Language :: Python :: 3.4',