BREAKING CHANGES!: refactor setup.py to pyproject.toml and many more …

.env.example

@@ -1,6 +1,7 @@
-ENV=development
-DEBUG=true
+# ENV=LOCAL
+# DEBUG=false
+# TZ=UTC
 
-BEANS_LOGGING_DISABLE_DEFAULT=false
-BEANS_LOGGING_CONFIG_PATH="./configs/logger.yml"
-BEANS_LOGGING_LOGS_DIR="./logs"
+# BEANS_LOGGING_DISABLE_DEFAULT=false
+# BEANS_LOGGING_CONFIG_PATH="./configs/logger.yml"
+# BEANS_LOGGING_LOGS_DIR="./logs"

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @bybatkhuu

.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    labels:
+      - "dependency"
+    open-pull-requests-limit: 10
+    schedule:
+      interval: "daily"

.github/workflows/1.bump-version.yml

@@ -12,14 +12,12 @@ on:
 jobs:
   bump_version:
     name: Bump Version
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     permissions:
       contents: write
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
+        uses: actions/checkout@v5
       - name: Bump version
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/2.build-publish.yml

@@ -12,50 +12,54 @@ on:
 jobs:
   test:
     name: 2.1. Test
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     permissions:
       contents: read
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
-          python-version: "3.9"
+          python-version: "3.10"
       - name: Install dependencies
         run: |
           python -m pip install -U pip
-          python -m pip install -r ./requirements.test.txt
+          python -m pip install .[test]
       - name: Test with pytest
         run: ./scripts/test.sh -l
 
   build_publish:
     needs: test
     name: 2.2. Build and Publish
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     permissions:
       contents: write
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v5
+      - name: Get latest version
+        run: |
+          git pull origin main
+          echo "Current version: v$(./scripts/get-version.sh)"
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
-          python-version: "3.9"
+          python-version: "3.10"
       - name: Install dependencies
         run: |
           python -m pip install -U pip
-          python -m pip install -r ./requirements.build.txt
+          python -m pip install -r ./requirements/requirements.build.txt
       - name: Build and publish package
-      # run: |
-      #   echo -e "[testpypi]\nusername = __token__\npassword = ${{ secrets.TEST_PYPI_API_TOKEN }}" > ~/.pypirc
-      #   ./scripts/build.sh -c -u
-      #   rm -rfv ~/.pypirc
+        # run: |
+        #   echo -e "[testpypi]\nusername = __token__\npassword = ${{ secrets.TEST_PYPI_API_TOKEN }}" > ~/.pypirc
+        #   ./scripts/build.sh -c -u
+        #   rm -rfv ~/.pypirc
         run: |
           echo -e "[pypi]\nusername = __token__\npassword = ${{ secrets.PYPI_API_TOKEN }}" > ~/.pypirc
           ./scripts/build.sh -c -u -p
           rm -rfv ~/.pypirc
       - name: Create release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: gh release create v$(./scripts/get-version.sh) ./dist/* --generate-notes
+        run: ./scripts/release.sh

.github/workflows/3.update-changelog.yml

@@ -0,0 +1,24 @@
+name: 3. Update Changelog
+
+on:
+  workflow_run:
+    workflows: ["2. Build and Publish"]
+    types:
+      - completed
+
+jobs:
+  build_publish:
+    name: Update Changelog
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+      - name: Update changelog
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git config user.name "github-actions"
+          git config user.email "github-actions@github.com"
+          ./scripts/changelog.sh -c -p

.github/workflows/publish-docs.yml

@@ -0,0 +1,37 @@
+name: Publish Docs
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+
+jobs:
+  deploy:
+    name: Publish Docs
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install -U pip
+          python -m pip install -r ./requirements/requirements.docs.txt
+      - name: Publish mkdocs
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git config user.name "github-actions"
+          git config user.email "github-actions@github.com"
+          ./scripts/docs.sh -p

.gitignore

@@ -1,8 +1,8 @@
 # File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig
-# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,jetbrains,jupyternotebooks,linux,python,sublimetext,vim,windows,zsh
-# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,macos,jetbrains,jupyternotebooks,linux,python,sublimetext,vim,windows,zsh
+# Created by https://www.toptal.com/developers/gitignore/api/zsh,xcode,windows,visualstudiocode,vim,sublimetext,python,powershell,macos,linux,jupyternotebooks,jetbrains+all,obsidian
+# Edit at https://www.toptal.com/developers/gitignore?templates=zsh,xcode,windows,visualstudiocode,vim,sublimetext,python,powershell,macos,linux,jupyternotebooks,jetbrains+all,obsidian
 
-### JetBrains ###
+### JetBrains+all ###
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
@@ -81,39 +81,14 @@ fabric.properties
 # Android studio 3.1+ serialized cache file
 .idea/caches/build_file_checksums.ser
 
-### JetBrains Patch ###
-# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+### JetBrains+all Patch ###
+# Ignore everything but code style settings and run configurations
+# that are supposed to be shared within teams.
 
-# *.iml
-# modules.xml
-# .idea/misc.xml
-# *.ipr
-
-# Sonarlint plugin
-# https://plugins.jetbrains.com/plugin/7973-sonarlint
-.idea/**/sonarlint/
-
-# SonarQube Plugin
-# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
-.idea/**/sonarIssues.xml
-
-# Markdown Navigator plugin
-# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
-.idea/**/markdown-navigator.xml
-.idea/**/markdown-navigator-enh.xml
-.idea/**/markdown-navigator/
+.idea/*
 
-# Cache file creation bug
-# See https://youtrack.jetbrains.com/issue/JBR-2257
-.idea/$CACHE_FILE$
-
-# CodeStream plugin
-# https://plugins.jetbrains.com/plugin/12206-codestream
-.idea/codestream.xml
-
-# Azure Toolkit for IntelliJ plugin
-# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
-.idea/**/azureSettings.xml
+!.idea/codeStyles
+!.idea/runConfigurations
 
 ### JupyterNotebooks ###
 # gitignore template for Jupyter Notebooks
@@ -177,6 +152,17 @@ Temporary Items
 # iCloud generated files
 *.icloud
 
+### Obsidian ###
+# config dir
+.obsidian/
+
+### PowerShell ###
+# Exclude packaged modules
+*.zip
+
+# Exclude .NET assemblies from source
+*.dll
+
 ### Python ###
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -444,6 +430,23 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
+### Xcode ###
+## User settings
+xcuserdata/
+
+## Xcode 8 and earlier
+*.xcscmblueprint
+*.xccheckout
+
+### Xcode Patch ###
+*.xcodeproj/*
+!*.xcodeproj/project.pbxproj
+!*.xcodeproj/xcshareddata/
+!*.xcodeproj/project.xcworkspace/
+!*.xcworkspace/contents.xcworkspacedata
+/*.gcno
+**/xcshareddata/WorkspaceSettings.xcsettings
+
 ### Zsh ###
 # Zsh compiled script + zrecompile backup
 *.zwc
@@ -479,35 +482,31 @@ zsdoc/data
 /tests/_output/*
 !/tests/_output/.gitkeep
 
-# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,jetbrains,jupyternotebooks,linux,python,sublimetext,vim,windows,zsh
+# End of https://www.toptal.com/developers/gitignore/api/zsh,xcode,windows,visualstudiocode,vim,sublimetext,python,powershell,macos,linux,jupyternotebooks,jetbrains+all,obsidian
 
 # Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
 
+# Directories:
+log/
+logs/
+backup/
+backups/
+tmp/
+data/
+dataset/
+datasets/
+.benchmarks/
 
 # Files:
-data
-dataset
-datasets
 log
 logs
 backup
 backups
-archive
-pythonpath
+tmp
+data
+dataset
+datasets
+.benchmarks
 *.bak
-*.pyc
-sample.py
 example.py
 test.py
-
-# Directories:
-.benchmarks/
-data/
-dataset/
-datasets/
-log/
-logs/
-backup/
-backups/
-archive/
-pythonpath/

.markdownlint.json

@@ -1,4 +1,7 @@
 {
-	"MD007": { "indent": 4 },
-	"MD013": false
+	"MD007": {
+		"indent": 4
+	},
+	"MD013": false,
+	"MD025": false
 }