Merge pull request #86 from FATEMEH-Z-HASHEMI/refactor/email-template

⚡  🔨  Refactor and Update Email Template with Formatted Date, Time, and New Design

.github/FUNDING.yml

@@ -0,0 +1,8 @@
+# These are supported funding model platforms
+
+github: django_logging
+patreon:
+open_collective: django_logging
+ko_fi: # Replace with a single Ko-fi username
+tidelift: "pypi/dj-logging"
+custom: # Replace with a single custom sponsorship URL

.github/workflows/ci.yml

@@ -4,15 +4,25 @@ on: [push, pull_request]
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-20.04
+
+    strategy:
+      matrix:
+        python-version:
+          - '3.8'
+          - '3.9'
+          - '3.10'
+          - '3.11'
+          - '3.12'
 
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python
+      - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
-          python-version: '3.x'
+          python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
         run: |

.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  release:
+    name: Build and Release
+    runs-on: ubuntu-latest
+
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+
+      - name: Build package
+        run: |
+          poetry build
+
+      - name: Publish to PyPI
+        run: |
+          poetry publish --username __token__ --password ${{ secrets.PYPI_TOKEN }}
+        env:
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}

.pre-commit-config-ci.yaml

@@ -29,7 +29,7 @@ repos:
       - id: tox-ini-fmt
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.17.0
+    rev: v3.15.2
     hooks:
       - id: pyupgrade
 

.pre-commit-config.yaml

@@ -29,7 +29,7 @@ repos:
       - id: tox-ini-fmt
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.17.0
+    rev: v3.15.2
     hooks:
       - id: pyupgrade
 

.readthedocs.yaml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.8"
+    python: "3.12"
 
 # Build documentation with Sphinx
 sphinx:

AUTHORS.md

@@ -0,0 +1,10 @@
+## Authors
+
+- **Aryan Niknezhad**
+  - GitHub: [ARYAN-NIKNEZHAD](https://github.com/ARYAN-NIKNEZHAD)
+  - Email: aryan513966@gmail.com
+
+
+- **Mehrshad Mirshekary**
+  - GitHub: [MEHRSHAD-MIRSHEKARY](https://github.com/MEHRSHAD-MIRSHEKARY)
+  - Email: mehrshad_mirshekary@email.com

CHANGELOG.md

@@ -1,3 +1,92 @@
-# Changelog
+## v1.1.0 (2024-09-12)
 
-All notable changes to this project will be documented in this file.
+### 🔧 Chore
+- **chore(pyproject)**: Added new markers to pytest configurations. ([3a1448c](https://github.com/lazarus-org/django_logging/commit/3a1448c))
+  - Updated pytest configuration with new markers for improved testing control.
+
+### 📚 Documentation
+- **docs(Usage)**: Add documentation for `execution_tracker` decorator. ([2713377](https://github.com/lazarus-org/django_logging/commit/2713377))
+  - Added detailed usage instructions for the new `execution_tracker` decorator.
+  - Provided examples and log output descriptions for different configurations.
+
+- **README**: Update documentation for `execution_tracker`. ([9272093](https://github.com/lazarus-org/django_logging/commit/9272093))
+  - Expanded README with detailed explanations of the `execution_tracker` decorator, including argument descriptions and usage examples.
+
+### ✨ Features
+- **feat(decorators)**: Add `execution_tracker` for performance metrics. ([3650c32](https://github.com/lazarus-org/django_logging/commit/3650c32))
+  - Added a decorator that logs execution time, database queries, and query thresholds for performance monitoring.
+  - Includes error handling and warnings when query thresholds are exceeded.
+
+- **feat(validators)**: Add `integer_setting` validator in `config_validators`. ([890b2c1](https://github.com/lazarus-org/django_logging/commit/890b2c1))
+  - Introduced a validator to ensure positive integer settings, improving configuration validation in `execution_tracker`.
+
+### ✅ Tests
+- **tests(decorators)**: Add tests for `execution_tracker` decorator. ([d6d3d8b](https://github.com/lazarus-org/django_logging/commit/d6d3d8b))
+  - Comprehensive test coverage for the `execution_tracker` decorator, including performance, query logging, and error handling scenarios.
+
+### ⚡ Refactor
+- **docs**: Improve RST docs readability and highlights. ([6b6c12a](https://github.com/lazarus-org/django_logging/commit/6b6c12a))
+  - Enhanced readability and formatting in reStructuredText documentation files for better user guidance.
+
+### 🔀 Merged
+- **Merge PR #83**: Merged `chore/pytest` into main. ([e3b3beb](https://github.com/lazarus-org/django_logging/commit/e3b3beb))
+- **Merge PR #82**: Merged `update/docs` into main. ([8647a37](https://github.com/lazarus-org/django_logging/8647a37))
+- **Merge PR #81**: Merged `feat/execution-tracker` into main. ([76b5621](https://github.com/lazarus-org/django_logging/commit/76b5621))
+
+## v1.0.4 (2024-09-05)
+
+### 🚀 CI
+- **ci**: Added automated build and release process. ([1a3bb2b](https://github.com/lazarus-org/django_logging/commit/1a3bb2b))
+  - Added a GitHub Actions workflow for automated build and release.
+  - Workflow triggers on new tags matching the `v*.*.*` pattern.
+  - Includes steps to set up Python, install dependencies, and build the package using Poetry.
+  - Automatically publishes the built package to PyPI using stored PyPI token secrets.
+  - Ensures the release job only runs after the 'test' job passes successfully.
+
+### ⚡️🔨📚 Refactor
+- **docs**: Updated badges in README MarkDown file. ([c82f452](https://github.com/lazarus-org/django_logging/commit/c82f452))
+  - Added pylint badge to display code quality rating in `README.md`.
+  - Updated pre-commit badge color.
+
+- **docs**: Updated badges and references in RST docs. ([c82f452](https://github.com/lazarus-org/django_logging/commit/c82f452))
+  - Added pylint badge to the documentation.
+  - Updated the settings section in various `.rst` files to reflect recent changes.
+  - Enhanced documentation for better readability and accuracy.
+
+## v1.0.3 (2024-09-05)
+### ✨ Added
+- **chore(pyproject)**: Added `python-semantic-release` configuration to automate versioning and releases. (`945c648`)
+- **docs**: Added pre-commit badge to display status in documentation. (`f40a9e5`, `7fca7b7`)
+
+### 🛠️ Changed
+- **docs**: Updated badge URLs and paths in documentation for correct references. (`f40a9e5`, `7fca7b7`)
+
+### 🐛 Fixed
+- **pyproject**: Updated dependencies and development requirements in the `pyproject.toml` configuration. (`945c648`)
+
+### 🔀 Merged
+- **Merge PR #77**: Merged the `chore/pyproject-config` branch into the main branch. (`c2ebad3`)
+
+## v1.0.2 (2024-09-02)
+**Added**
+- tag_format in commitizen configuration in pyproject.toml
+- changelog path in poetry urls
+- Add FUNDING.yml file
+
+**Refactored**
+- Renamed setup_django into settings_configuration in tests dir
+- Moved settings_configuration from fixtures into tests root dir
+
+
+## v1.0.1 (2024-09-02)
+**Refactored**
+- Updated badges path in README.md and installation guide
+- Updated badges path in index.rst and installation guide
+- Updated headers in RestructuredText documentations
+
+**Fixed**
+- Removed repository from tool.poetry
+- Fixed read the docs path in poetry urls
+
+## v1.0.0 (2024-09-02)
+- initial Release

LICENCE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 django_logging
+Copyright (c) 2024 Lazarus
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal