Sunday, April 14, 2019

Abhijeet Pal: The Ultimate Visual Studio Code Setup For Django Developers

Visual Studio the text editor is known as Visual Studio Code is Microsoft’s free text editor that runs on Windows, Linux, and macOS. It’s a recent entrant to the market; Microsoft released the product as a public preview at the end of 2015, posting the open source code to Github, before making it available as a general release in April 2016.

Despite its newbie status, Visual Studio Code has rapidly gained popularity among developers. Some may argue that it is not a real IDE, but merely an advanced text editor. But in my opinion, after installing a number of extensions, it becomes almost a full-fledged IDE with very rich functionality.

Additionally, despite being an Electron-based application, it is quite lightweight and responsive (in contrast to for example Atom, which is very slow and resource intensive).

This tutorial will go through Installation and setup of the VS code for Python and Django projects on your machine.

Installing Visual Studio Code

Visual Studio Code is a free text editor so to download it you just have to visit their official site and download the file depending on your operating system. So visit Vscode’s-website and download the latest stable build for your OS and once the download is finished install the editor and launch the app.

Getting Started with Python in VS Code

The best thing about VScode is that it comes with a built-in terminal which comes handy for Django projects press Ctrl+Shift+` to invoke the terminal.

Vs code setup for python

Note that in windows powershell may seem weird for new users it is recommended to use Python debug console or CMD.

Configuring Python

To enjoy Pythonic features such as Linting, Debugging (multi-threaded, remote), Intellisense, code formatting, refactoring, unit tests, snippets, and more you need to install Python extension for Vscode.

To install an extension press Ctrl+Shift+x or click the extension icon.

Using VS Code for Python/Django Development

Now search for Python and install the one published by Microsoft.

Python for vscode

Adding Extension For Django

Search for Djaneiro this extension provides a collection of snippets for Django templates, models, views, fields & forms ported from Djaneiro for SublimeText.

Selecting Python Environment

Press CTRL+SHIFT+P(CMD+SHIFT+P for MacOS) and type Python: Select Interpreter and select the environment for your project. You can see the active environment at the bottom left of the editor.

Vs code python environment

Installing Theme

The default Vscode theme is great in itself however there are plenty for fabulous free theme available for download. My favorite one is Ayu Mirage.

To install or change a theme go to, file>Preference> color theme

vscode change theme

And select Ayu mirage or any other theme that you prefer.

Python vscode

Notice below color theme there is an option for file icon theme click on that and select Ayu this will give different file icons for your project which will help you in distinguishing between them.

file icon

After that restart VS code to activate the extensions. Now open any of your Django project you should get this beautiful view.

django in vscode

Font’s look a bit small you can increase them in workspace setting I usually keep it to 19. To change the font size got to file>Prefernce> Settings then change the font size in workspace settings.

vscode django setup

Configuring  Additional Useful Settings

Go to file> preferece> settings then open settings.json from there.

settings.json python vscode

In USER SETTINGS inside the curly braces { } add the following Settings.

// my custom settings
    "editor.formatOnSave": true,
    "editor.rulers": [
        80,
        120
    ],
    "files.exclude": {
        "**/.git": true,
        "**/.svn": true,
        "**/.hg": true,
        "**/CVS": true,
        "**/.DS_Store": true,
        ".vscode": true,
        "**/*.pyc": true,
    },
    "workbench.editor.enablePreview": false,
    "files.autoSave": "afterDelay",
    "files.autoSaveDelay": 500,
    "editor.minimap.enabled": false,

To use the above features, the editor will prompt you to install pylint and autopep8, or you can install them directly in the virtual environment.

pip install autopep8
pip install pylint

VS Code for Python/Django Development

The post The Ultimate Visual Studio Code Setup For Django Developers appeared first on Django Central.



from Planet Python
via read more

No comments:

Post a Comment

TestDriven.io: Working with Static and Media Files in Django

This article looks at how to work with static and media files in a Django project, locally and in production. from Planet Python via read...