VS Code Setup for Python
========================

`Getting Started with Python in VS Code <https://code.visualstudio.com/docs/python/python-tutorial>`_ is a great tutorial for setting up VS Code. This note we're covering relevant aspects of the setup {for the impatient}. 

Following is contents of `.vscode/settings.json`

.. code-block:: json

    {
    "editor.tabSize": 4,
    "editor.rulers": [79, 120],
    "editor.formatOnSave": true,
    "python.linting.lintOnSave": true,
    "python.pythonPath": "env/bin/python",
    "python.linting.enabled": true,
    "python.linting.pylintEnabled": true,
    "python.linting.pylintPath": "env/bin/pylint",
    "python.formatting.provider": "autopep8",
    "python.formatting.autopep8Path": "env/bin/autopep8",
    "python.formatting.autopep8Args": [
        "--max-line-length",
        "120",
        "--experimental"
        ]
    }

.. note:: If you're using `pipenv`, you can run `pipenv where` to figure out base directory where virtual environment is installed

In crux following is what we're doing

1. We're creating `.vscode/settings.json` which is like a workspace configuration file {within your project/repo}
2. In this file we're specifically defining
    1. `python.pythonPath` which points to Python binary of your virtual environment
    2. `python.linting.pylintPath` specifies binary of your linter. {View list of officially supported `Linters <https://code.visualstudio.com/docs/python/linting#_specific-linters>`_}
    3. `python.formatting.provider`, `python.formatting.autopep8Path` and `python.formatting.autopep8Args` are setting we're using for formatters. {View list of officially supporte `Formatters <https://code.visualstudio.com/docs/python/editing#_formatting>`_}

Associated with this there is also `Automate Python workflow using pre-commits: black and flake8 <https://ljvmiranda921.github.io/notebook/2018/06/21/precommits-using-black-and-flake8/>`_

`bandit <https://github.com/PyCQA/bandit>`_ is another tool that checks for security issues in Python code

References:

1. `Get Productive with Python in Visual Studio Code by Dan Taylor <https://www.youtube.com/watch?v=6YLMWU-5H9o>`_
2. `How Code Linters Can Help You Write More Pythonic Code <https://realpython.com/lessons/how-code-linters-can-help-you-write-more-pythonic-code/>`_