Added pre-commit hook & black, isort, flake for lint code and auto-update

Author: paqstd-dev

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 88

.github/workflows/tests.yml

@@ -33,15 +33,25 @@ jobs:
         run: |
           python manage.py test
 
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+      - uses: pre-commit/[email protected]
+
   coverage:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python 3.10
+      - name: Set up Python 3.11
         uses: actions/setup-python@v4
         with:
-          python-version: 3.10
+          python-version: 3.11
 
       - name: Install dependencies
         run: |
@@ -50,7 +60,7 @@ jobs:
 
       - name: Run tests with coverage
         run: |
-          python -m coverage run --source='.' manage.py test   
+          python -m coverage run --source='.' manage.py test
 
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v3

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: check-toml
+      - id: trailing-whitespace
+
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 23.10.1
+    hooks:
+      - id: black
+        language_version: python3.11
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        name: isort (python)
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8

LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -65,8 +65,8 @@ If you choose not use it as a built-in, you will need to add `{% load simple_com
 ### 3. Hooray! Everything is ready to use it.
 
 ## Contributing
-If you would like to suggest a new feature, you can create an issue on the GitHub repository for this project. 
-If you'd like to contribute code, you can fork the repository and submit a pull request with your changes.
+If you would like to suggest a new feature, you can create an issue on the GitHub repository for this project.
+Also you can fork the repository and submit a pull request with your changes.
 
 ## License
 This project is licensed under the MIT License. See the LICENSE file for more information.

pyproject.toml

@@ -43,3 +43,17 @@ omit = [
     "setup.py",
     "tests/*"
 ]
+
+[tool.black]
+line-length = 88
+target-version = ["py311"]
+include = "\\.pyi?$"
+skip-string-normalization=true
+
+[tool.isort]
+profile = "django"
+combine_as_imports = true
+include_trailing_comma = true
+line_length = 88
+multi_line_output = 3
+known_first_party = ["config"]

simple_components/templatetags/simple_components.py

@@ -1,7 +1,13 @@
 import re
+
 from django import template
 
-from ..exceptions import SetComponentNameError, ComponentNameError, ComponentArgsError, ComponentNotDefined
+from ..exceptions import (
+    ComponentArgsError,
+    ComponentNameError,
+    ComponentNotDefined,
+    SetComponentNameError,
+)
 
 # allow line breaks inside tags
 template.base.tag_re = re.compile(template.base.tag_re.pattern, re.DOTALL)
@@ -41,10 +47,11 @@ def render(self, context):
 @register.tag
 def component(parser, token):
     bits = token.split_contents()
-    if len(bits) < 2 or '=' in bits[1]:
-        example = '{% component \"name\" ' + ' '.join(bits[1:]) + ' %}'
+    if len(bits) < 2 or "=" in bits[1]:
+        example = '{% component "name" ' + ' '.join(bits[1:]) + ' %}'
         raise ComponentNameError(
-            'Component takes at least one required argument (name of component):\n%s' % example
+            'Component takes at least one required argument (name of component):\n%s'
+            % example
         )
 
     component_name = str(parser.compile_filter(bits[1]))
@@ -58,7 +65,9 @@ def component(parser, token):
         if name:
             kwargs[name] = parser.compile_filter(value)
         else:
-            example = '{% component "' + component_name + '" param1=%s' % bit + ' ... %}'
+            example = (
+                '{% component "' + component_name + '" param1=%s' % bit + ' ... %}'
+            )
             raise ComponentArgsError(
                 'Argument %s must be takes as kwargs:\n%s' % (bit, example)
             )
@@ -76,8 +85,8 @@ def render(self, context):
             nodelist = context['components'][self.component_name]
         except KeyError:
             raise ComponentNotDefined(
-                'The component \'%s\' has not been previously defined. Check that the component is named correctly.'
-                % self.component_name
+                'The component \'%s\' has not been previously defined. '
+                'Check that the component is named correctly.' % self.component_name
             )
 
         if self.kwargs is not None:

tests/settings.py

@@ -7,10 +7,12 @@
 
 ALLOWED_HOSTS = []
 
+# fmt: off
 INSTALLED_APPS = [
     'tests',
     'simple_components'
 ]
+# fmt: on
 
 ROOT_URLCONF = 'tests.urls'
 
@@ -27,9 +29,11 @@
     },
 ]
 
+# fmt: off
 DATABASES = {
     'default': {
         'ENGINE': 'django.db.backends.sqlite3',
         'NAME': ':memory:'
     }
 }
+# fmt: on

tests/templates/newlines.html

@@ -16,4 +16,4 @@ <h3>{{ title }}</h3>
     description="World"
 
     other="..."
-%}
+%}

tests/tests.py

@@ -1,5 +1,5 @@
-from django.test import TestCase
 from django.template.loader import render_to_string
+from django.test import TestCase
 
 from simple_components import exceptions
 
@@ -37,13 +37,7 @@ def test_components_with_context(self):
         context = {
             'list': ['apple', 'banana', 'tomato'],
             'string': 'django',
-            'dict': {
-                'a': {
-                    'b': {
-                        'c': 123
-                    }
-                }
-            }
+            'dict': {'a': {'b': {'c': 123}}},
         }
 
         template = render_to_string('context.html', context)