diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile new file mode 100644 index 00000000..0e77490b --- /dev/null +++ b/.devcontainer/Dockerfile @@ -0,0 +1,22 @@ +# FROM: +# https://github.com/microsoft/vscode-dev-containers/blob/v0.177.0/containers/python-3/.devcontainer +# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6 +ARG VARIANT=3.7 +FROM mcr.microsoft.com/vscode/devcontainers/python:${VARIANT} + +# [Option] Install Node.js +ARG INSTALL_NODE="true" +ARG NODE_VERSION="lts/*" +RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi + +# [Optional] If your pip 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 + +# [Optional] Uncomment this line to install global node packages. +# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 \ No newline at end of file diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 00000000..032437de --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,59 @@ +// 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.177.0/containers/python-3 +{ + "name": "Python 3", + "build": { + "dockerfile": "Dockerfile", + "context": "..", + "args": { + // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9 + "VARIANT": "3.7", + // Options + "INSTALL_NODE": "false", + "NODE_VERSION": "lts/*" + } + }, + + // Set *default* container specific settings.json values on container create. + "settings": { + "terminal.integrated.shell.linux": "/bin/bash", + "python.pythonPath": "/usr/local/bin/python", + "python.languageServer": "Pylance", + "python.linting.enabled": true, + "python.linting.pylintEnabled": 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.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", + "files.trimTrailingWhitespace": true, + "files.insertFinalNewline": true + }, + + // Add the IDs of extensions you want installed when the container is created. + "extensions": [ + "ms-python.python", + "ms-python.vscode-pylance", + "davidanson.vscode-markdownlint", + "bierner.markdown-mermaid", + "mhutchie.git-graph" + ], + + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], + + // Use 'postCreateCommand' to run commands after the container is created. + // "postCreateCommand": "pip3 install --user -r requirements.txt", + + // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. + "remoteUser": "vscode", + "portsAttributes": { + "8000": { + "label": "documentation website" + } + } +} \ No newline at end of file diff --git a/.gitignore b/.gitignore index 7581459f..b948b1c8 100644 --- a/.gitignore +++ b/.gitignore @@ -82,7 +82,7 @@ coverage.xml # mkdocs documentation site/* -# Jupyter +# Jupyter .ipynb_checkpoints profile_default/ ipython_config.py @@ -116,7 +116,6 @@ venv.bak/ .project .pydevproject .settings -.vscode # mypy .mypy_cache/ diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 00000000..7c53b772 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,23 @@ +{ + "recommendations": [ + "ms-python.python", + "ms-python.vscode-pylance", + "njqdev.vscode-python-typehint", + "njpwerner.autodocstring", + "davidanson.vscode-markdownlint", + "bierner.markdown-mermaid", + "takumii.markdowntable", + "github.copilot", + "github.vscode-pull-request-github", + "mhutchie.git-graph", + "eamodio.gitlens", + "jasonnutter.vscode-codeowners", + "tamasfe.even-better-toml", + "redhat.vscode-yaml", + "zainchen.json", + "randomfractalsinc.geo-data-viewer", + "tht13.html-preview-vscode", + "visualstudioexptteam.vscodeintellicode", + "ms-toolsai.jupyter", + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..d745a2a1 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,6 @@ +{ + "python.formatting.provider": "black", + "python.analysis.typeCheckingMode": "basic", + "python.testing.pytestEnabled": true, + "files.trimTrailingWhitespace": true +} \ No newline at end of file