Introduce poetry and poethepoet

Author: monim67

.coveragerc

@@ -16,22 +16,28 @@ Follow the following steps to get started contributing to this project.
         git checkout -b name-of-your-bugfix-or-feature
 
  3. Create a virtual environment of your choice and activate it.
- 4. Install the dependencies via pip and run the migrations for django application.
+ 4. Install the dependencies via poetry and activate poetry virtual environment.
 
-        make
+        poetry install
+        poetry shell
 
- 5. Now you can run the django application on localhost:8000 to see the changes you make in action real-time.
+ 5. Run the migrations for django application.
 
-        make dev
+        python dev/manage.py migrate
+
+ 6. Press F5 if you are using vscode to start the application debugger.
+ 7. Otherwise you can run the django application on localhost:8000 to see the changes you make in action real-time.
+
+        python dev/manage.py runserver
 
 
 ## Testing
 
  1. Run the tests by the following command.
 
-        make test
+        pytest
 
  2. See the coverage report by the following command.
 
-        make coverage
+        poe coverage
 

.github/CONTRIBUTING.md

@@ -0,0 +1 @@
+custom: ['https://www.buymeacoffee.com/monim67']

.github/FUNDING.yml

@@ -2,29 +2,37 @@ name: build
 
 on:
   push:
-    branches: ['*']
+    branches: ["*"]
   pull_request:
 
 jobs:
   build:
     if: "!contains(github.event.head_commit.message, 'skip-ci')"
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.9", "3.8", "3.7"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - name: Set up Python 3.6
-        uses: actions/setup-python@v2
+      - name: Install poetry
+        run: pipx install poetry
+
+      - uses: actions/setup-python@v3
         with:
-          python-version: '3.6'
+          python-version: ${{ matrix.python-version }}
+          cache: poetry
 
-      - name: Install
-        run: python3 -m pip install -r requirements/build.txt
+      - name: Install dependencies
+        run: |
+          poetry env use ${{ matrix.python-version }}
+          poetry install --no-interaction
 
       - name: Lint
-        run: make lint
+        run: poetry run poe lint
 
-      - name: Test & Coverage
-        run: make coverage
+      - name: Test Coverage
+        run: poetry run coverage run
 
       - name: Coveralls.io notification
         uses: AndreMiras/coveralls-python-action@develop
@@ -36,7 +44,7 @@ jobs:
     needs: build
     runs-on: ubuntu-latest
     steps:
-    - name: Coveralls Finished
-      uses: AndreMiras/coveralls-python-action@develop
-      with:
-        parallel-finished: true
+      - name: Coveralls Finished
+        uses: AndreMiras/coveralls-python-action@develop
+        with:
+          parallel-finished: true

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: deploy
+name: Deploy to PyPI
 
 on:
   release:
@@ -7,21 +7,26 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-latest
+    env:
+      POETRY_VIRTUALENVS_CREATE: "false"
     steps:
-    - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-    - name: Set up Python 3.6
-      uses: actions/setup-python@v2
-      with:
-        python-version: '3.6'
+      - name: Install poetry
+        run: pipx install poetry
 
-    - name: Install dependencies
-      run: 'python -m pip install build wheel --user'
+      - uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
 
-    - name: Build
-      run: make build
+      - name: Build
+        run: |
+          poetry version ${{ github.ref_name }}
+          sed -i "" "s/\[tool.poetry.dependencies\]/[tool.poetry.group.excluded.dependencies]/" pyproject.toml
+          sed -i "" "s/\[tool.poetry.group.pypi.dependencies\]/[tool.poetry.dependencies]/" pyproject.toml
+          poetry build
 
-    - name: Publish to PyPI
-      uses: pypa/gh-action-pypi-publish@master
-      with:
-        password: ${{ secrets.PYPI_API_TOKEN }}
+      - name: Publish
+        run: |
+          poetry config pypi-token.pypi ${{ secrets.PYPI_API_TOKEN }}
+          poetry publish

.github/workflows/deploy.yml

@@ -1,16 +1,22 @@
-/venv*
-.vscode
+/tmp
 node_modules
 db.sqlite3
 docs/_build
-docs/pydoc.io/autoapi
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
 .pytest_cache/
 *.py[cod]
 *$py.class
 
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.history/*
+
 # Unit test / coverage reports
 htmlcov/
 .tox/

.gitignore

@@ -0,0 +1,19 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Django: runserver",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}/dev/manage.py",
+            "args": [
+                "runserver"
+            ],
+            "django": true,
+            "justMyCode": true
+        },
+    ]
+}

.pylintrc

@@ -0,0 +1,14 @@
+{
+  "python.formatting.provider": "black",
+  "python.testing.pytestEnabled": true,
+  "python.testing.unittestEnabled": false,
+  "[python]": {
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.organizeImports": true,
+    }
+  },
+  "yaml.schemas": {
+    "https://json.schemastore.org/github-workflow.json": ".github/workflows/*.yml"
+  },
+}

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "shell",
+			"label": "docs:build",
+			"command": "poetry run make -C docs html",
+			"problemMatcher": [],
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			}
+		},
+	]
+}