danieltakeshi/dev-environment-1

Steps to get dev env set up on a new gCloud instance with Ubuntu 18.04. First, install some stuff needed for YCM later:

sudo apt update
sudo apt install build-essential cmake

Clone this repository, follow steps in install.sh, run the steps manually as I find it easier:

cp -a bashrc ~/.bashrc
./install_python.sh

Now here, if you update bashrc, you'll get (base) and can use conda commands:

. ~/.bashrc
conda config --set auto_activate_base false
. ~/.bashrc

At this point, commands like conda info --envs and python should both work. Then do the last step:

./install_vim.sh

And now YCM should be installed. :)

(Normal README follows)

Dev Environment Setup

This are config files and install scripts for a number of programs that I often use. It mostly sets up a python development environment with vim. At the moment it contains

• .bashrc
• .vimrc + ftplugin commands for vim
• .tmux.conf (tells tmux to use 256 color)
• install script for vim8 (requires sudo - vim8 needed for asynchronous linting)
• install script for tmux new version (with or without sudo)
• install script for miniconda and python3.6

Bashrc

The .bashrc file mainly changes the status line so that it gives you some information about the status of any git repository you may be in. There are extensions that do this in different ways, but I prefer what I have because it's simple, clean, and fast.

The .bashrc will also change color settings that may be required for 256-bit color across tmux, vim, ssh, etc. If you have problems with colors and you haven't copied the .bashrc file, you may want start here.

Finally, if gruvbox (see the vim plugin below) is available on your machine, it will switch to using that as your colorscheme. You may or may not want this, so feel free to delete the corresponding line (search for gruvbox in the .bashrc) if you don't.

Vim Plugins

I use a bunch of vim plugins to make quality of life improvements for vim. Some of these are general quality of life improvements and some are targeted specifically for python editing. Here's a list.

Vundle

Vundle is a vim package manager, which is used to download and install all the other packages. That means it has to be installed first, and separately. If you don't already have vundle installed, the install_vim.sh script will clone and install the repository for you.

ALE

Asynchronous Lint Engine (ALE) is a tool for linting your code asynchronously (obviously). Older vim setup guides suggest using syntastic, but I found syntastic to be extremely slow. I enable two linters by default (mypy and flake8). Settings for the linters can be found in .vim/ftplugin/python.vim.

YouCompleteMe

YouCompleteMe (YCM) is a code completion module that works in basically every language and is very fast. It does require compilation, but the install_vim.sh script should do this for you. This will also do linting/completion in C/C++ which I've found to be quite good and very useful.

Jedi

Jedi is a python tool for autocompletion and showing documentation. This tool is basically superseded by YCM, but YCM lacks one of the best features of jedi-vim, which is to show the call signatures a function as you type it in. I'm looking for a better solution than actually just including both packages, but I've yet to find one.

SimpylFold

Vim doesn't do python code folding well be default. SimpylFold fixes that.

FastFold

Vim folding is a little slow - this speeds it up. I also change the fold command to map <Space> so it's really easy to open and close folds.

NerdTree

NerdTree is a pretty standard addition to vim and provides an easier-to-navigate folder structure when you open a folder in vim. Honestly, I don't use nerdtree that much, and I find the default vim folder navigation feature pretty much ok. NerdTree does have some nice features like this git plugin that lets you see the changes you've made.

Fugitive

A git wrapper that turns a lot of git commands into vim commands. It also provides information on the status of the file you're currently editing.

Airline

Gives you a nice status and tabline. It also has integration with a bunch of other plugins (like ALE and fugitive) which can display additional information. It will also display the buffers you have open.

Python Syntax

This changes what vim highlights as python syntax. It's actually forked from a different repository, because I've changed it to also highlight function calls (function definitions and function calls are in different colors).

DelimitMate

This plugin adds auto-closing of quotes, parentheses, brackets, etc.

Markdown Preview

A pretty lightweight markdown previewer. There are others, and I have no specific reason to praise this one over those, so you may want to experiment.

Gruvbox

A vim colorscheme that I actually use across vim and terminal. It's not everyone's favorite, and you can change the colorscheme in .vimrc by changing the colo gruvbox command to be whichever colorscheme you prefer. My .bashrc file will also switch to using gruvbox if it's available on your machine, which you can enable (just search for gruvbox in the .bashrc and delete the line on which it appears).

Known Problems

The main known issue is with ssh, tmux, and colors. Currently the 256-bit colors will not work with standard Mac terminal, but will work with iTerm. Alternatively, you can downgrade to 16-bit colors by removing the set termguicolors command in the .vimrc.

If you do want to use gruvbox colors in terminal, the current .bashrc might be enough to make it work. If not, I found the easiest way to fix the colors is to manually go to settings and change the colors used to the ones gruvbox uses. You can find a list of colors on the gruvbox GitHub page.