Add pre-commit with first config and first formatting pass (#33)

Author: jowilf

.github/workflows/build-docs.yml

@@ -12,4 +12,4 @@ jobs:
           python-version: 3.8
       - name: Install Dependencies
         run: pip install hatch
-      - run: hatch run docs_deploy
+      - run: hatch run docs_deploy

.github/workflows/publish.yml

@@ -26,4 +26,4 @@ jobs:
         env:
           HATCH_INDEX_USER: __token__
           HATCH_INDEX_AUTH: ${{ secrets.PYPI_TOKEN }}
-        run: hatch publish
+        run: hatch publish

.github/workflows/test.yml

@@ -92,4 +92,4 @@ jobs:
       - name: Coverage Report
         run: hatch run cov
       - name: Upload coverage
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v3

.gitignore

@@ -15,4 +15,4 @@ site
 .cache
 __pycache__/
 .pytest_cache/
-.examples/
+.examples/

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+    -   id: check-added-large-files
+    -   id: check-toml
+    -   id: check-yaml
+        args:
+        -   --unsafe
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v3.2.3
+    hooks:
+    -   id: pyupgrade
+        args:
+        - --py3-plus
+        - --keep-runtime-typing
+-   repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.146
+    hooks:
+    -   id: ruff
+        args:
+        - --fix
+-   repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+    -   id: black

CHANGELOG.md

@@ -1,3 +1,3 @@
 # Changelog
 
-Please check [this page in the documentation](https://jowilf.github.io/starlette-admin/changelog/).
+Please check [this page in the documentation](https://jowilf.github.io/starlette-admin/changelog/).

README.md

@@ -45,7 +45,7 @@
     * [MongoEngine](http://mongoengine.org/)
     * [ODMantic](http://mongoengine.org/)
 - Custom backend ([doc](https://jowilf.github.io/starlette-admin/advanced/base-model-view/), [example](https://github.com/jowilf/starlette-admin/tree/main/examples/custom-backend))
-  
+
 
 ## Installation
 
@@ -109,4 +109,4 @@ Access your admin interface in your browser at [http://localhost:8000/admin](htt
 - [flatpickr](https://flatpickr.js.org/)
 - [moment](http://momentjs.com/)
 - [jsoneditor](https://github.com/josdejong/jsoneditor)
-- [fontawesome](https://fontawesome.com/)
+- [fontawesome](https://fontawesome.com/)

docs/advanced/base-model-view.md

@@ -71,7 +71,7 @@ class PostView(BaseModelView):
 
 ## Fields
 
-Internally, *Starlette-Admin*  uses custom fields all inherit from [BaseField][starlette_admin.fields.BaseField] to 
+Internally, *Starlette-Admin*  uses custom fields all inherit from [BaseField][starlette_admin.fields.BaseField] to
 represent each attribute. So, you need to choose the right field for each attribute or create a new field if needed.
 See [API Reference][starlette_admin.fields.BaseField] for full list of default fields.
 
@@ -224,4 +224,4 @@ class PostView(BaseModelView):
                 cnt += 1
         return cnt
 
-```
+```

docs/advanced/custom-field.md

@@ -31,11 +31,11 @@ the admin class
     This is simple example with SQLAlchemy backend
     ```python
     from starlette_admin.contrib.sqla import Admin as BaseAdmin
-    
+
     class Admin(BaseAdmin):
         def custom_render_js(self, request: Request) -> Optional[str]:
             return request.url_for("statics", path="js/custom_render.js")
-    
+
     admin = Admin(engine)
     admin.add_view(...)
     ```
@@ -50,7 +50,7 @@ the admin class
 !!! note
     `fieldOptions` is your field as javascript object. Your field attributes is serialized into
     javascript object by using dataclass `asdict` function.
-    
+
 * Then, set `render_function_key` value
 
 ```python
@@ -59,7 +59,7 @@ from dataclasses import dataclass
 
 @dataclass
 class CustomField(BaseField):
-    render_function_key: str = "mycustomkey" 
+    render_function_key: str = "mycustomkey"
 ```
 
 ## Form
@@ -91,8 +91,8 @@ from dataclasses import dataclass
 
 @dataclass
 class CustomField(BaseField):
-    render_function_key: str = "mycustomkey" 
-    form_template: str = "forms/custom.html" 
+    render_function_key: str = "mycustomkey"
+    form_template: str = "forms/custom.html"
 ```
 
 ## Detail Page
@@ -115,12 +115,12 @@ from dataclasses import dataclass
 
 @dataclass
 class CustomField(BaseField):
-    render_function_key: str = "mycustomkey" 
-    form_template: str = "forms/custom.html" 
+    render_function_key: str = "mycustomkey"
+    form_template: str = "forms/custom.html"
     display_template = "displays/custom.html"
 ```
 
-## Data processing 
+## Data processing
 
 For data processing you will need to override two functions:
 
@@ -157,4 +157,4 @@ class CustomField(BaseField):
 
 
 !!! important
-    Override `dict` function to get control of the options which is available in javascript.
+    Override `dict` function to get control of the options which is available in javascript.

docs/alternatives.md

@@ -2,4 +2,4 @@
 
 * [Flask-Admin:](https://github.com/flask-admin/flask-admin) Simple and extensible administrative interface framework for Flask. The main goal of this project is to provide similar tool for Starlette/FastApi.
 * [FastApi-Admin:](https://github.com/fastapi-admin/fastapi-admin) A fast admin dashboard based on FastAPI and TortoiseORM.
-* [sqladmin:](https://github.com/aminalaee/sqladmin) SQLAlchemy Admin for FastAPI and Starlette
+* [sqladmin:](https://github.com/aminalaee/sqladmin) SQLAlchemy Admin for FastAPI and Starlette

docs/api/auth-provider.md

@@ -1 +1 @@
-:::starlette_admin.auth.AuthProvider
+:::starlette_admin.auth.AuthProvider

docs/api/base-admin.md

@@ -1 +1 @@
-:::starlette_admin.base.BaseAdmin
+:::starlette_admin.base.BaseAdmin

docs/api/fields.md

@@ -21,4 +21,4 @@
 :::starlette_admin.fields.HasOne
 :::starlette_admin.fields.HasMany
 :::starlette_admin.fields.ListField
-:::starlette_admin.fields.CollectionField
+:::starlette_admin.fields.CollectionField

docs/api/views.md

@@ -2,4 +2,4 @@
 :::starlette_admin.views.DropDown
 :::starlette_admin.views.Link
 :::starlette_admin.views.CustomView
-:::starlette_admin.views.BaseModelView
+:::starlette_admin.views.BaseModelView

docs/changelog.md

@@ -27,7 +27,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
     class Post:
         id: int
         title: str
-    
+
     admin.add_view(ModelView(Post, icon="fa fa-blog", label = "Blog Posts"))
     ```
 
@@ -36,12 +36,12 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
     class Post:
         id: int
         title: str
-          
-    
+
+
     class PostView(ModelView, model=Post):
         icon = "fa fa-blog"
         label = "Blog Posts"
-    
+
     admin.add_view(PostView)
     ```
 
@@ -58,7 +58,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
         icon = "fa fa-home"
         path = "/home"
         template_path = "home.html"
-    
+
     admin.add_view(HomeView)
     ```
 
@@ -83,14 +83,14 @@ These changes are inspired from *Flask-admin* and are introduced to help reduce
 
 * Add `CollectionField`
 * Add `ListField`
-* Add support for [Odmantic](https://art049.github.io/odmantic/) 
+* Add support for [Odmantic](https://art049.github.io/odmantic/)
 * Add support for datatables [responsive extensions](https://datatables.net/extensions/responsive/)
 !!! usage
     ```python
     class MyModelView(ModelView):
         responsive_table = True
     ```
-  
+
 ### Changed
 
 * Move `SQLModel` to it own contrib package

docs/index.md

@@ -45,7 +45,7 @@
     * [MongoEngine](http://mongoengine.org/)
     * [ODMantic](http://mongoengine.org/)
 - Custom backend ([doc](https://jowilf.github.io/starlette-admin/advanced/base-model-view/), [example](https://github.com/jowilf/starlette-admin/tree/main/examples/custom-backend))
-  
+
 
 ## Installation
 
@@ -109,4 +109,4 @@ Access your admin interface in your browser at [http://localhost:8000/admin](htt
 - [flatpickr](https://flatpickr.js.org/)
 - [moment](http://momentjs.com/)
 - [jsoneditor](https://github.com/josdejong/jsoneditor)
-- [fontawesome](https://fontawesome.com/)
+- [fontawesome](https://fontawesome.com/)

docs/stylesheets/extra.css

@@ -1,4 +1,4 @@
 :root > * {
   --md-primary-fg-color:        #0073BB;
   --md-primary-fg-color--dark:  #005c96;
-}
+}

docs/tutorial/authentication.md

@@ -82,7 +82,7 @@ from starlette_admin import CustomView
 from starlette.requests import Request
 
 class ReportView(CustomView):
-    
+
     def is_accessible(self, request: Request) -> bool:
         return "admin" in request.state.user_roles
 ```
@@ -122,4 +122,3 @@ class PostView(ModelView):
     def can_delete(self, request: Request) -> bool:
         return "admin" in request.state.user_roles
 ```
-

docs/tutorial/configurations/admin.md

@@ -1,4 +1,4 @@
-# Admin Configurations 
+# Admin Configurations
 
 Multiple options are available to customize your admin interface
 
@@ -30,4 +30,4 @@ admin = Admin(
 * `templates_dir`: Templates dir for customisation
 * `index_view`: CustomView to use for index page.
 * `auth_provider`: Authentication Provider
-* `middlewares`: Starlette middlewares
+* `middlewares`: Starlette middlewares

docs/tutorial/configurations/modelview.md

@@ -73,13 +73,13 @@ Two options are available to specify which fields can be sorted or searched.
 You can export your data from list page. The export options can be set per model and includes the following options:
 
 * `export_fields`:  List of fields to include in exports.
-* `export_types`: A list of available export filetypes. Available 
+* `export_types`: A list of available export filetypes. Available
 exports are `['csv', 'excel', 'pdf', 'print']`. By default, All of them are activated by default.
 
 !!! Example
     ```Python
     from starlette_admin import ExportType
-    
+
     class PostView(ModelView):
         export_fields = [Post.id, Post.content, Post.tags]
         export_types = [ExportType.CSV, ExportType.EXCEL]
@@ -91,7 +91,7 @@ The pagination options in the list page can be configured. The available options
 
 * `page_size`: Default number of items to display in List page pagination.
             Default value is set to `10`.
-* `page_size_options`: Pagination choices displayed in List page.  Default value is set to `[10, 25, 50, 100]`. 
+* `page_size_options`: Pagination choices displayed in List page.  Default value is set to `[10, 25, 50, 100]`.
      Use `-1`to display All
 
 
@@ -114,4 +114,4 @@ The template files are built using Jinja2 and can be completely overridden in th
     ```Python
     class PostView(ModelView):
         detail_template = "post_detail.html"
-    ```
+    ```