WIP

.editorconfig

@@ -24,3 +24,8 @@ max_line_length = 120
 # YAML files
 [*.{yaml,yml}]
 indent_size = 2
+
+# Shell scripts
+[*.sh]
+indent_size = 2
+indent_style = tab

.gitattributes

@@ -1,11 +1,73 @@
-# Adding the following lines to the .gitattributes file will tell Git to treat the files as binary data.
-*.text filter=lfs diff=lfs merge=lfs -text
-*.png filter=lfs diff=lfs merge=lfs -text
+# Common document and text file formats
+*.docx filter=lfs diff=lfs merge=lfs -text
+*.doc filter=lfs diff=lfs merge=lfs -text
+*.pdf filter=lfs diff=lfs merge=lfs -text
+*.djvu filter=lfs diff=lfs merge=lfs -text
+*.eps filter=lfs diff=lfs merge=lfs -text
+*.odt filter=lfs diff=lfs merge=lfs -text
+*.rtf filter=lfs diff=lfs merge=lfs -text
+*.ps filter=lfs diff=lfs merge=lfs -text
+*.xls filter=lfs diff=lfs merge=lfs -text
+*.xlsx filter=lfs diff=lfs merge=lfs -text
+*.ppt filter=lfs diff=lfs merge=lfs -text
+*.pptx filter=lfs diff=lfs merge=lfs -text
+
+# Common image formats
 *.jpg filter=lfs diff=lfs merge=lfs -text
 *.jpeg filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
 *.gif filter=lfs diff=lfs merge=lfs -text
-*.csv filter=lfs diff=lfs merge=lfs -text
+*.bmp filter=lfs diff=lfs merge=lfs -text
+*.tiff filter=lfs diff=lfs merge=lfs -text
+*.tif filter=lfs diff=lfs merge=lfs -text
+*.svgz filter=lfs diff=lfs merge=lfs -text
+
+# Common compressed file formats
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+
+# Common file formats in machine learning projects
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.tfrecord filter=lfs diff=lfs merge=lfs -text
+*.hdf5 filter=lfs diff=lfs merge=lfs -text
+*.keras filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+
+# Common audio and video formats
+*.mp3 filter=lfs diff=lfs merge=lfs -text
+*.mp4 filter=lfs diff=lfs merge=lfs -text
+*.wav filter=lfs diff=lfs merge=lfs -text
+*.avi filter=lfs diff=lfs merge=lfs -text
+*.mov filter=lfs diff=lfs merge=lfs -text
+*.flac filter=lfs diff=lfs merge=lfs -text
+*.mkv filter=lfs diff=lfs merge=lfs -text
+*.webm filter=lfs diff=lfs merge=lfs -text
+*.ogg filter=lfs diff=lfs merge=lfs -text
+*.ogv filter=lfs diff=lfs merge=lfs -text
+
+# Common data transfer formats
+#*.csv filter=lfs diff=lfs merge=lfs -text
+#*.tsv filter=lfs diff=lfs merge=lfs -text
+#*.json filter=lfs diff=lfs merge=lfs -text
+#*.xml filter=lfs diff=lfs merge=lfs -text
 *.parquet filter=lfs diff=lfs merge=lfs -text
+*.feather filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.avro filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.orc filter=lfs diff=lfs merge=lfs -text
 
 # Exclude files from language stats (GitHub Linguist)
 *.ipynb linguist-vendored

.github/workflows/tests.yml

@@ -27,9 +27,9 @@ jobs:
 
       - name: Install Dependencies
         run: |
-          poetry install --with dev
+          poetry install --with dev --no-root
 
-      - name: Run Tests
+      - name: Run Tests with Coverage
         shell: bash
         env:
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

LICENSE

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

README.md

@@ -8,20 +8,37 @@
 [![pip downloads](https://img.shields.io/pypi/dm/easy-letters.svg)](https://pypi.org/project/easy-letters/)
 
 Easy Letters is a Python library that can help job seekers write application letters.
-Currently, it proves the basic blocks for creating a simple retrieval augmented generation (RAG) pipeline
+Currently, it proves the basic building blocks for creating a naive retrieval augmented generation (or RAG) pipeline
 to generate application letter drafts.
 The user can then edit the draft letter to suit their needs.
 
-See the [notebooks/README.md](notebooks/README.md) file for how it works.
+The diagram below shows the high-level workflow of how Easy Letters how can be used to generate draft application
+letters.
 
-### Installation
+![Easy Letters Workflow](assets/workflow.svg)
 
-You can install Easy Letters using pip:
+### Installation
 
 ```bash
 pip install easy-letters
 ```
 
+#### Installing from Source
+
+You can also install Easy Letters from the source code in this repository.
+The main benefit of this approach is that you might find it easier to run the sample notebooks and modify the code as
+you wish this way.
+
+After cloning this repository, you can navigate to the directory where you cloned the repository and install the
+dependencies using [Poetry](https://python-poetry.org/):
+
+```bash
+git clone https://github.com/habedi/easy-letters.git && cd easy-letters
+
+# Install the dependencies using Poetry
+poetry install --with dev
+```
+
 ### Getting Started
 
 #### API Key Setup
@@ -36,7 +53,7 @@ So you need to set the following environment variables to be able to use Easy Le
 You can find Jupyter notebooks with example code in the [notebooks](notebooks/) directory.
 The notebooks demonstrate how to use Easy Letters to generate application letter drafts.
 
-#### Supported Models
+### Supported Models
 
 Easy Letters currently supports the following models:
 
@@ -49,22 +66,6 @@ Easy Letters currently supports the following models:
 | Text Embedding 3 (Small Variant) | Text Embedding  |
 | Text Embedding 3 (Large Variant) | Text Embedding  |
 
-#### Installing from Source
-
-You can also install Easy Letters from the source code in this repository.
-The main benefit of this approach is that you might find it easier to run the sample notebooks and modify the code as
-you wish this way.
-
-After cloning this repository, you can navigate to the directory where you cloned the repository and install the
-dependencies using [Poetry](https://python-poetry.org/):
-
-```bash
-git clone https://github.com/habedi/easy-letters.git && cd easy-letters
-
-# Install the dependencies using Poetry
-poetry install --with dev --no-root
-```
-
 ### License
 
 Easy Letters is available under the MIT license ([LICENSE](LICENSE)).

assets/make_figures.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+# You need to have Graphviz installed to run this script
+# On Debian-based systems, you can install it using: sudo apt-get install graphviz
+
+# Make figures from .dot files
+for f in *.dot; do
+    dot -Tsvg $f -o ${f%.dot}.svg
+done