118 lines (90 loc) · 4.66 KB

Python

Setup

Install Python 3
- On a Unix-based OS, the system's default Python installation is normally Python 2. Check this by running python --version on a terminal. If this is so, install Python 3 but DO NOT REMOVE / OVERWRITE / UNINSTALL the old Python 2. The system uses Python 2 for its internal scripts and removing it may break the OS installation.
- For Linux, either install it from apt or from source
  - How to install Python3.7 on Ubuntu18.04?
- For Mac, use Homebrew
  - Installing Python 3 on Mac OS X
  - How is Python handled by Homebrew
- Verify the Python installation by running
```
$ which python3
$ python3 --version
```
Setup and use a virtual environment
- There are many different modules for creating a virtual environment
- If Python 2 support is needed, use the virtualenv module
- If Python 3 only, use the built-in venv or pipenv
  - For venv
    - Set VENV_DIR to directory for virtual environments (ex. $HOME/.venvs)
    - Copy the bash aliases for using venv
      - mkvenv PROJECT_NAME
      - upvenv PROJECT_NAME
      - dnvenv
      - rmvenv PROJECT_NAME
      - lsvenv
  - For pipenv
    - Set WORKON_HOME to directory for virtual environments (ex. $HOME/.venvs)
    - How to set pipenv shell prompt to match the Terminal's PS1 prompt?
For each Python project
- For virtualenv and venv
  - Create/Activate a virtual environment
```
$ mkvenv NAME /path/to/python
```
  - Create a requirements.txt file
```
$ pip freeze > requirements.txt
```
  - Commit the requirements.txt file
  - When switching environments:
```
$ pip install -r requirements.txt
```
- For pipenv
  - Create/Activate a virtual environment
```
$ pipenv --python=/path/to/python
```
  - Create a Pipfile
```
$ pipenv install PACKAGE
$ pipenv install --dev PACKAGE
```
  - Commit the generated Pipfile and Pipfile.lock
  - When switching environments:
```
$ pipenv sync
```

FAQ

Coding Conventions

Package Management

Managing Python packages the right way

Notable Modules

Linters

Formatters

black
yapf

Terminal

ipython - Enhanced interactive Python shell

CLI

colorama - Cross-platform colorizer for console logs
click - For creating CLI-based applications
tqdm - For better progress bars and loop tracking

Web Application

flask - Lightweight web application framework

Data Visualization

bokeh - Interactive and embeddable images for modern web browsers