Merge pull request #9 from cloudblue/LITE-27806-add-isort-black

LITE-27806 Add isort and black

Author: maxipavlovic

.gitignore

@@ -129,3 +129,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Idea IDE
+.idea

README.md

@@ -86,7 +86,10 @@ Due to implementation and Mongo engine features there may be some limitations in
 ## Development
 
 1. Python 3.8+
-0. Install dependencies `pip install poetry && poetry install`
+2. Install dependencies `pip install poetry && poetry install`
+3. We use `isort` library to order and format our imports, and `black` - to format the code. 
+   We check it using `flake8-isort` and `flake8-black` libraries (automatically on `flake8` run).  
+   For convenience you may run `docker compose run format` to format the code.
 
 ## Testing
 

docker-compose.yml

@@ -10,7 +10,7 @@ services:
 
   app_test:
     container_name: django_mongoengine_rql_test
-    image: django_mongoengine_rql_test
+    image: django_mongoengine_rql
     build:
       context: .
       dockerfile: Dockerfile
@@ -23,3 +23,14 @@ services:
       MONGO_HOST: mongo
       MONGO_USER: root
       MONGO_PASSWORD: 1q2w3e
+
+  format:
+    container_name: django_mongoengine_rql_format
+    image: django_mongoengine_rql
+    build:
+      context: .
+      dockerfile: Dockerfile
+    command: >
+      bash -c 'poetry run isort . && poetry run black .'
+    volumes:
+      - ./:/app