Add isort to our linting toolkit (#14)

This adds isort to our CI pipeline, which checks the order and format of imports. Developers can use isort to automatically do import sorting for them, and a section on this is now in the README. We configure isort to use the "black" profile, which should prevent any disagreements on import formatting between the two tools. However, in CI, we always run black last to give it the final say on formatting.

Author: velovix

.circleci/config.yml

@@ -25,6 +25,7 @@ jobs:
       - run: "curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py
           | python3 - --version 1.1.0"
       - run: poetry install --no-root
+      - run: poetry run isort --check .
       - run: poetry run black --check .
       - run: poetry run mypy -p "brainframe.cli"
   upload_to_pypi:

README.rst

@@ -44,3 +44,20 @@ using the ``compose`` command, which can be run from any directory.
 For more information, take a look at the `Getting Started guide`_.
 
 .. _`Getting Started guide`: https://aotu.ai/docs/getting_started/
+
+Contributing
+------------
+
+We happily take community contributions! If there's something you'd like to
+work on, but you're not sure how to start, feel free to create an issue on
+Github and we'll try to point you in the right direction.
+
+We use a couple formatting tools to keep our code style consistent. If you get
+any CI failures, you can run the following commands to automatically format
+your code to fit our guidelines:
+
+.. code-block:: bash
+
+    poetry run isort .
+    poetry run black .
+

brainframe/cli/commands/__init__.py

@@ -1,6 +1,6 @@
 from .backup import backup
 from .compose import compose
+from .info import info
 from .install import install
 from .update import update
-from .info import info
 from .utils import by_name

brainframe/cli/commands/backup.py

@@ -4,15 +4,15 @@
 from pathlib import Path
 
 import i18n
-
 from brainframe.cli import (
-    print_utils,
-    docker_compose,
-    os_utils,
     dependencies,
+    docker_compose,
     env_vars,
+    os_utils,
+    print_utils,
 )
-from .utils import subcommand_parse_args, command
+
+from .utils import command, subcommand_parse_args
 
 BACKUP_DIR_FORMAT = "%Y-%m-%d_%H-%M-%S"
 

brainframe/cli/commands/compose.py

@@ -1,8 +1,8 @@
 import sys
 
 import i18n
-
 from brainframe.cli import docker_compose, env_vars, os_utils, print_utils
+
 from .utils import command
 
 

brainframe/cli/commands/info.py

@@ -1,9 +1,9 @@
 from argparse import ArgumentParser
 
 import i18n
+from brainframe.cli import docker_compose, env_vars, print_utils
 
-from brainframe.cli import env_vars, print_utils, docker_compose
-from .utils import subcommand_parse_args, command
+from .utils import command, subcommand_parse_args
 
 
 @command("info")

brainframe/cli/commands/install.py

@@ -2,15 +2,15 @@
 from pathlib import Path
 
 import i18n
-
 from brainframe.cli import (
-    print_utils,
+    dependencies,
     docker_compose,
     env_vars,
     os_utils,
-    dependencies,
+    print_utils,
 )
-from .utils import subcommand_parse_args, command
+
+from .utils import command, subcommand_parse_args
 
 
 @command("install")

brainframe/cli/commands/update.py

@@ -1,10 +1,10 @@
 from argparse import ArgumentParser
-from packaging import version
 
 import i18n
+from brainframe.cli import docker_compose, env_vars, print_utils
+from packaging import version
 
-from brainframe.cli import print_utils, docker_compose, env_vars
-from .utils import subcommand_parse_args, command
+from .utils import command, subcommand_parse_args
 
 
 @command("update")

brainframe/cli/dependencies.py

@@ -1,6 +1,6 @@
 import shutil
 
-from . import print_utils, os_utils
+from . import os_utils, print_utils
 
 
 class Dependency:

brainframe/cli/docker_compose.py

@@ -1,11 +1,12 @@
+import os
 import subprocess
 from pathlib import Path
-from typing import List, Tuple, cast, TextIO
-import yaml
+from typing import List, TextIO, Tuple, cast
+
 import i18n
-import os
+import yaml
 
-from . import os_utils, print_utils, env_vars
+from . import env_vars, os_utils, print_utils
 
 # The URL to the docker-compose.yml
 BRAINFRAME_DOCKER_COMPOSE_URL = "https://{subdomain}aotu.ai/releases/brainframe/{version}/docker-compose.yml"