Merge pull request #13 from MousaZeidBaker/linting_and_formatting

Add linter and formatters

.github/workflows/publish.yaml

@@ -29,6 +29,11 @@ jobs:
       - name: Install dependencies
         run: poetry install
 
+      - name: Lint
+        run: |
+          source $(poetry env info --path)/bin/activate # activate virtual environment
+          flake8 .
+
       - name: Test
         run: |
           source $(poetry env info --path)/bin/activate # activate virtual environment
@@ -64,6 +69,11 @@ jobs:
       - name: Install dependencies
         run: poetry install
 
+      - name: Lint
+        run: |
+          source $(poetry env info --path)/bin/activate # activate virtual environment
+          flake8 .
+
       - name: Test
         run: |
           source $(poetry env info --path)/bin/activate # activate virtual environment

.github/workflows/test.yaml

@@ -29,6 +29,11 @@ jobs:
       - name: Install dependencies
         run: poetry install
 
+      - name: Lint
+        run: |
+          source $(poetry env info --path)/bin/activate # activate virtual environment
+          flake8 .
+
       - name: Test
         run: |
           source $(poetry env info --path)/bin/activate # activate virtual environment

README.md

@@ -19,12 +19,6 @@ running `poetry update` and `poetryup`, is that the latter also modifies the `py
 poetryup
 ```
 
-## Test
-Activate virtualenv & Install project dependencies
-```shell
-poetry shell && poetry install
-```
-
 Run tests
 ```shell
 pytest tests
@@ -36,3 +30,34 @@ Contributions are welcome via pull requests.
 ## Issues
 If you encounter any problems, please file an [issue](https://github.com/MousaZeidBaker/poetryup/issues) along with a
 detailed description.
+
+## Develop
+Activate virtual environment
+```shell
+poetry shell
+```
+
+Install dependencies
+```shell
+poetry install
+```
+
+Run tests
+```shell
+pytest tests
+```
+
+Run linter
+```shell
+flake8 .
+```
+
+Format code
+```shell
+black .
+```
+
+Sort imports
+```shell
+isort .
+```