Bring in black + update README

dbader · dbader · commit 33729a092f6d · 2018-10-09T15:08:45.000-07:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -6,7 +6,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: circleci/python:3.6.1
+      - image: circleci/python:3.6
 
     working_directory: ~/repo
 
@@ -25,6 +25,7 @@ jobs:
           command: |
             python3 -m venv venv
             . venv/bin/activate
+            pip install --upgrade pip
             pip install -r .circleci/requirements.txt
 
       - save_cache:
@@ -33,7 +34,8 @@ jobs:
           key: v1-dependencies-{{ checksum ".circleci/requirements.txt" }}
 
       - run:
-          name: flake8
+          name: Code style check
           command: |
             . venv/bin/activate
-            flake8 --exclude=venv
+            flake8
+            black --check .
diff --git a/.circleci/requirements.txt b/.circleci/requirements.txt
@@ -1 +1,2 @@
+black==18.9b0
 flake8==3.5.0
diff --git a/README.md b/README.md
@@ -1,4 +1,24 @@
 # Real Python Materials
+
 Bonus materials, exercises, and example projects for our [Python tutorials](https://realpython.com).
 
 Build Status: [![CircleCI](https://circleci.com/gh/realpython/materials.svg?style=svg)](https://circleci.com/gh/realpython/materials)
+
+## Running Code Style Checks
+
+We use [flake8](http://flake8.pycqa.org/en/latest/) and [black](https://github.com/ambv/black) to ensure a consistent code style for all of our sample code in this repository.
+
+Run the following commands to validate your code against the linters:
+
+```sh
+$ flake8
+$ black --check .
+```
+
+## Running Python Code Formatter
+
+To automatically re-format your code to be consistent with our code style guidelines, run [black](https://github.com/ambv/black) in the repository root folder:
+
+```sh
+$ black .
+```
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,11 @@
+[tool.black]
+line-length = 79
+py36 = true
+exclude = '''
+/(
+  \.git
+  | venv
+  | migrations
+  | node_modules
+)/
+'''
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,5 @@
+[flake8]
+exclude = .git,venv
+
+[pycodestyle]
+exclude = .git,venv
