Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
3020025
Merge pull request #64 from ARYAN-NIKNEZHAD/develop
ARYAN-NIKNEZHAD Aug 31, 2024
6f6b535
Merge pull request #66 from ARYAN-NIKNEZHAD/develop
ARYAN-NIKNEZHAD Sep 1, 2024
42b55b2
:zap::art::books: Update(README) to improve doc structure
MEHRSHAD-MIRSHEKARY Sep 1, 2024
98063ed
:zap::art::hammer refactor(README): Update readme docs badges
MEHRSHAD-MIRSHEKARY Sep 1, 2024
ec0e78e
:hammer::zap::art: refactor(docs): Update index.rst to modify badges
MEHRSHAD-MIRSHEKARY Sep 1, 2024
3da46b1
:wrench: chore(build): Update pyproject.toml metadata
MEHRSHAD-MIRSHEKARY Sep 1, 2024
c949914
Merge pull request #67 from MEHRSHAD-MIRSHEKARY/refactor/docs
ARYAN-NIKNEZHAD Sep 1, 2024
778046a
Merge pull request #68 from MEHRSHAD-MIRSHEKARY/update/build-config
ARYAN-NIKNEZHAD Sep 1, 2024
bd38844
:zap: Update(template) email_notifier img
MEHRSHAD-MIRSHEKARY Sep 1, 2024
e1d70d9
Merge pull request #69 from MEHRSHAD-MIRSHEKARY/update/email-template
ARYAN-NIKNEZHAD Sep 1, 2024
38dc89a
:bug: fix(CI):skip some python versions on tox
MEHRSHAD-MIRSHEKARY Sep 1, 2024
6f83f33
Merge pull request #70 from MEHRSHAD-MIRSHEKARY/fix/CI-python-version
ARYAN-NIKNEZHAD Sep 1, 2024
49cf61b
:wrench: chore: Update pyproject.toml config
MEHRSHAD-MIRSHEKARY Sep 1, 2024
2eb498d
:books: docs: Add authors.md file
MEHRSHAD-MIRSHEKARY Sep 1, 2024
f83bfd1
:zap::bulb: docs: Add docstring in checks & ready method
MEHRSHAD-MIRSHEKARY Sep 1, 2024
d8e2608
Merge pull request #71 from MEHRSHAD-MIRSHEKARY/refactor/code-base
ARYAN-NIKNEZHAD Sep 1, 2024
14e7af5
:zap::hammer: refactor(docs):update quick start section in readme.md …
MEHRSHAD-MIRSHEKARY Sep 2, 2024
a27c2d9
Merge pull request #72 from MEHRSHAD-MIRSHEKARY/refactor/docs
ARYAN-NIKNEZHAD Sep 2, 2024
968b48c
:hammer::zap: refactor(constants): implement ani colors as data class
MEHRSHAD-MIRSHEKARY Sep 2, 2024
ae0b27b
:zap::hammer: refactor: update usage of ansi colors to apply new changes
MEHRSHAD-MIRSHEKARY Sep 2, 2024
af5ce06
Merge pull request #73 from MEHRSHAD-MIRSHEKARY/refactor/docs
ARYAN-NIKNEZHAD Sep 2, 2024
96cf55b
:books::zap: docs: add codecov badges
MEHRSHAD-MIRSHEKARY Sep 2, 2024
f384261
Merge pull request #74 from MEHRSHAD-MIRSHEKARY/refactor/docs
ARYAN-NIKNEZHAD Sep 2, 2024
cf6bcd4
:wrench: chore: Update name of pyproject.toml config
ARYAN-NIKNEZHAD Sep 2, 2024
623603b
:wrench: chore: Update pyproject.toml config
ARYAN-NIKNEZHAD Sep 2, 2024
23637e7
:wrench: chore: Update pyproject&docs config
ARYAN-NIKNEZHAD Sep 2, 2024
dfcc9e0
:zap::books::hammer: refactor(docs): Update readme & rst files
MEHRSHAD-MIRSHEKARY Sep 2, 2024
d79fa24
Merge pull request #75 from MEHRSHAD-MIRSHEKARY/refactor/docs
ARYAN-NIKNEZHAD Sep 2, 2024
5a46349
:bookmark: build(django_logging): Publish version 1.0.1
ARYAN-NIKNEZHAD Sep 2, 2024
b8a4ccd
:wrench: chore: Update pyproject.toml config
ARYAN-NIKNEZHAD Sep 2, 2024
c84ea73
:wrench: Create FUNDING.yml
ARYAN-NIKNEZHAD Sep 2, 2024
5fd0c90
:zap::hammer: refactor: renamed setup_django in test fixtures
MEHRSHAD-MIRSHEKARY Sep 2, 2024
8363ea0
Merge pull request #76 from MEHRSHAD-MIRSHEKARY/main
ARYAN-NIKNEZHAD Sep 2, 2024
db41879
:bookmark: build(django_logging): Publish version 1.0.2
ARYAN-NIKNEZHAD Sep 2, 2024
7fca7b7
:books::hammer: refactor(docs): rename project urls & badge path in i…
MEHRSHAD-MIRSHEKARY Sep 4, 2024
f40a9e5
:zap::books: refactor(docs): Update badge path and url refrences
MEHRSHAD-MIRSHEKARY Sep 4, 2024
945c648
:wrench::zap: chore(pyproject): add python-semantic-release config
MEHRSHAD-MIRSHEKARY Sep 4, 2024
c2ebad3
Merge pull request #77 from MEHRSHAD-MIRSHEKARY/chore/pyproject-config
ARYAN-NIKNEZHAD Sep 4, 2024
c5fadd4
:bookmark: build(django_logging): Publish version 1.0.3
ARYAN-NIKNEZHAD Sep 4, 2024
c82f452
:zap::hammer::books: refactor(docs): update badges and refrences in r…
MEHRSHAD-MIRSHEKARY Sep 5, 2024
1a3bb2b
:zap::books::hammer: refactor(docs): Update badges in README MarkDown…
MEHRSHAD-MIRSHEKARY Sep 5, 2024
bcf90e0
:rocket: ci: add automated build and release process
MEHRSHAD-MIRSHEKARY Sep 5, 2024
8d41c70
:memo: update CHANGELOG.md for recent changes
MEHRSHAD-MIRSHEKARY Sep 5, 2024
bce3f25
Merge pull request #78 from MEHRSHAD-MIRSHEKARY/refactor/docs-and-build
ARYAN-NIKNEZHAD Sep 5, 2024
601e2b7
:wrench: Update release.yml
ARYAN-NIKNEZHAD Sep 5, 2024
80bacb3
:bookmark: build(django_logging): Publish version 1.0.4
ARYAN-NIKNEZHAD Sep 5, 2024
1c60340
Merge branch 'main' of github.com:ARYAN-NIKNEZHAD/django_logging
ARYAN-NIKNEZHAD Sep 5, 2024
72a06b5
:books: Update CHANGELOG.md
ARYAN-NIKNEZHAD Sep 5, 2024
6b6c12a
:zap::hammer::books::art: refactor(docs): Improve rst docs readabilit…
MEHRSHAD-MIRSHEKARY Sep 6, 2024
440355a
Merge pull request #79 from MEHRSHAD-MIRSHEKARY/refactor/rst-docs
ARYAN-NIKNEZHAD Sep 6, 2024
3650c32
:sparkles::zap: feat(decorators): Add execution_tracker for performan…
MEHRSHAD-MIRSHEKARY Sep 11, 2024
890b2c1
:zap::sparkles: feat(validators): Add integer_setting validator in co…
MEHRSHAD-MIRSHEKARY Sep 11, 2024
d6d3d8b
:rotating_light::white_check_mark::heavy_check_mark: tests(decorators…
MEHRSHAD-MIRSHEKARY Sep 11, 2024
9272093
:books::zap: Update(README): Add Documentation for execution_tracker …
MEHRSHAD-MIRSHEKARY Sep 11, 2024
76b5621
Merge pull request #81 from MEHRSHAD-MIRSHEKARY/feat/execution-tracker
MEHRSHAD-MIRSHEKARY Sep 11, 2024
2713377
:books::zap: docs(Usage): Add Documentation for execution_tracker Dec…
MEHRSHAD-MIRSHEKARY Sep 11, 2024
3a1448c
:wrench: chore(pyproject): add new markers to pytest configurations
MEHRSHAD-MIRSHEKARY Sep 11, 2024
8647a37
Merge pull request #82 from MEHRSHAD-MIRSHEKARY/update/docs
MEHRSHAD-MIRSHEKARY Sep 11, 2024
e3b3beb
Merge pull request #83 from MEHRSHAD-MIRSHEKARY/chore/pytest
MEHRSHAD-MIRSHEKARY Sep 11, 2024
abde13f
:books: docs: Update CHANGELOG file
ARYAN-NIKNEZHAD Sep 12, 2024
8d2f73d
:bookmark: build(django_logging): Publish version 1.1.0
ARYAN-NIKNEZHAD Sep 12, 2024
d3c00dd
:books: Update LICENCE file
ARYAN-NIKNEZHAD Sep 14, 2024
55f1ded
:zap::hammer: refactor(handlers): Update template context data to inc…
FATEMEH-Z-HASHEMI Sep 17, 2024
6e3e8cf
:zap: Update(tests): returned context in test_email_handler
FATEMEH-Z-HASHEMI Sep 17, 2024
a0902b7
:hammer::art: refactor(templates): Update email template with new des…
FATEMEH-Z-HASHEMI Sep 17, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -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
16 changes: 13 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
35 changes: 35 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -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 }}
2 changes: 1 addition & 1 deletion .pre-commit-config-ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "3.8"
python: "3.12"

# Build documentation with Sphinx
sphinx:
Expand Down
10 changes: 10 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -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
93 changes: 91 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion LICENCE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading