Fix

Author: Kaweees

.editorconfig

@@ -14,7 +14,7 @@ trim_trailing_whitespace = true
 insert_final_newline = true
 
 [*.md]
-indent_size = 3
+indent_size = 4
 
 [*.nix]
 indent_size = 2

.gitignore

@@ -1,9 +1,9 @@
 *
 
 !.github/
-!.github/**
+!.github/**/
 !assets/
-!assets/**
+!assets/**/
 !.editorconfig
 !.envrc
 !.gitattributes
@@ -17,13 +17,13 @@
 !README.md
 
 !scripts/
-!scripts/**
+!scripts/**/
 !shared/
-!shared/**
+!shared/**/
 !src/
-!src/**
+!src/**/
 !tests/
-!tests/**
+!tests/**/
 
 !*.md
 !*.mdc

.justfile

@@ -39,9 +39,9 @@ build target:
   @uv run hatch build --target {{target}}
 
 # Run a package
-run *args='core':
+run package="core" *args="":
   @echo "Running..."
-  @uv run {{args}}
+  @uv run {{package}} {{args}}
 
 # Test the project
 test:
@@ -53,8 +53,6 @@ check:
   @echo "Checking..."
   @uv lock --locked
   @uv run pre-commit run -a
-  @uv run mypy .
-  @uv run deptry . --ignore=DEP002,DEP003
 
 # Remove build artifacts and non-essential files
 clean:

.pre-commit-config.yaml

@@ -51,13 +51,13 @@ repos:
           ]
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: "v3.21.0"
+    rev: "v3.21.2"
     hooks:
       - id: pyupgrade
         args: ["--py310-plus", "--keep-runtime-typing"]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.14.1"
+    rev: "v0.14.6"
     hooks:
       # Formatter first so code is canonicalized
       - id: ruff-format

README.md

@@ -1,3 +1,8 @@
+<!--
+*** This readme was adapted from Best-README-Template.
+  https://github.com/othneildrew/Best-README-Template
+-->
+
 <!-- PROJECT SHIELDS -->
 <!--
 *** I'm using markdown "reference style" links for readability.
@@ -15,11 +20,11 @@
 </div>
 
 <a href="https://github.com/Kaweees/modern_python">
-  <img alt="Python Logo" src="assets/img/python.png" align="right" width="150">
+    <img alt="Python Logo" src="assets/img/python.png" align="right" width="150">
 </a>
 
 <div align="left">
-  <h1><em><a href="https://miguelvf.dev/blog/dotfiles/compendium">~modern_python</a></em></h1>
+    <h1><em><a href="https://github.com/Kaweees/modern_python">~modern_python</a></em></h1>
 </div>
 
 <!-- ABOUT THE PROJECT -->
@@ -34,26 +39,40 @@ A template for developing production-ready Python applications.
 [![Codecov][Codecov-shield]][Codecov-url]
 [![GitHub Actions][github-actions-shield]][github-actions-url]
 
-<!-- GETTING STARTED -->
+<!-- PROJECT PREVIEW -->
+## Preview
 
+<p align="center">
+    <img src="assets/img/demo.mp4" width = "80%" alt = "Video demonstration"/>
+</p>
+
+<!-- GETTING STARTED -->
 ## Getting Started
 
 ### Prerequisites
 
-Before attempting to build this project, make sure you have [Nix](https://nixos.org/download.html) with [Flake](https://nixos.wiki/wiki/Flakes) support installed on your machine.
+Before attempting to build this project, make sure you have [direnv](https://direnv.net/) and [Nix](https://nixos.org/download.html) with [Flake](https://nixos.wiki/wiki/Flakes) support installed on your machine.
 
 ### Installation
 
 To get a local copy of the project up and running on your machine, follow these simple steps:
 
 1. Clone the project repository
 
+    ```sh
+    git clone https://github.com/Kaweees/modern_python.git
+    cd modern_python
+    ```
+
+2. Install the project dependencies
+
+   If you have `direnv` installed, simply allow the environment:
+
    ```sh
-   git clone https://github.com/Kaweees/modern_python.git
-   cd modern_python
+   direnv allow
    ```
 
-2. Install the project dependencies
+   Otherwise, you can use `nix-shell` to enter the environment:
 
    ```sh
    nix-shell --max-jobs $(nproc) # Linux / Windows (WSL)
@@ -62,12 +81,11 @@ To get a local copy of the project up and running on your machine, follow these
 
 3. Run the project
 
-   ```sh
-   just run <package_name>
-   ```
+    ```sh
+    just run <package_name>
+    ```
 
 <!-- PROJECT FILE STRUCTURE -->
-
 ## Project Structure
 
 ```sh
@@ -86,7 +104,7 @@ modern_python/
 
 ## License
 
-The source code for [Kaweees/modern_python](https://github.com/Kaweees/modern_python) is distributed under the terms of the MIT License, as I firmly believe that collaborating on free and open-source software fosters innovations that mutually and equitably beneficial to both collaborators and users alike. See [`LICENSE`](./LICENSE) for details and more information.
+The source code for [Kaweees/modern_python](https://github.com/Kaweees/modern_python) is distributed under the terms of the GNU General Public License v3.0, as I firmly believe that collaborating on free and open-source software fosters innovations that mutually and equitably beneficial to both collaborators and users alike. See [`LICENSE`](./LICENSE) for details and more information.
 
 <!-- MARKDOWN LINKS & IMAGES -->
 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

ruff.toml

@@ -17,6 +17,8 @@ extend-select = [
   # Ruff-specific rules
   "RUF",
 ]
+select = ["E", "F", "I"]
+
 ignore = [
   "E402",   # Module level import not at top of file
   "E501",   # Line too long
@@ -28,15 +30,10 @@ ignore = [
   "SIM117", # Merge with statements for context managers that have same scope
   "SIM118", # Checks for key-existence checks against dict.keys() calls
 ]
-select = ["E", "F", "I"]
-
-[lint.per-file-ignores]
-"*/__init__.py" = ["F401"] # Unused import
 
 [lint.isort]
 known-first-party = ["modern_python", "core"]
 
-
 [lint.pydocstyle]
 convention = "google"
 

shell.nix

@@ -12,6 +12,7 @@ pkgs.mkShell {
 
   # Shell hook to set up environment
   shellHook = ''
+    export TMPDIR=/tmp
     just install
   '';
 }