Tirsvad-Udemy-100-days-of-code/024-mail-merge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README #2

Merged
Tirsvad merged 1 commits from docs/readme into main 2026-10-13 08:30:17 +02:00
Conversation 0 Commits 1 Files Changed 1
+84 -1
1 changed files with 84 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+84 -1
View File
@@ -1,2 +1,85 @@
# 024-mail-merge # 🚀 024-mail-merge
A small Python script that turns one letter template and a list of names into one personalised letter per name. It is the mail merge project from day 24 of the Udemy *100 Days of Code* course.
## 📚 Table of Contents
- [Overview](#-overview)
- [Requirements](#-requirements)
- [Setup](#-setup)
- [Run](#-run)
- [Tests](#-tests)
- [License](#-license)
- [Links](#-links)
- [Appendix: Project documents](#-appendix-project-documents)
## 🧭 Overview
The script reads the guest names from a file, replaces the `[name]` placeholder in a letter template with each name, and writes one letter per guest.
| Path | Purpose |
| --- | --- |
| `main.py` | The mail merge script |
| `Input/Names/invited_names.txt` | The guest names, one per line |
| `Input/Letters/starting_letter.txt` | The letter template containing `[name]` |
| `Output/ReadyToSend/` | The generated letters, `letter_for_<name>.txt` |
| `docs/` | Project documents |
| `framework/` | The SQA and QC framework this project uses (submodule) |
It uses three string and file methods: `readlines()` to read the names, `strip()` to remove the trailing newline from each name, and `replace()` to substitute the placeholder.
## 📋 Requirements
- Python 3, to run `main.py`. No third-party packages are needed.
## 🛠️ Setup
Clone the repository with its framework submodule:
```bash
git clone --recurse-submodules ssh://git.tirsystem.com:10022/Tirsvad-Udemy-100-days-of-code/024-mail-merge.git
```
## ▶️ Run
From the project root:
```bash
python main.py
```
The generated letters appear in `Output/ReadyToSend/`. To change the guests or the letter, edit the files under `Input/` and run the script again.
## 🧪 Tests
Not applicable.
## 📄 License
GNU Affero General Public License v3.0, see [LICENSE][license].
## 🔗 Links
- [Repository][repository]
- [Documentation][documentation]
- [Issue tracker][issues]
## 📎 Appendix: Project documents
| Document | What it tells you |
| --- | --- |
| [AGENTS.md][agents] | The rules AI agents follow in this repository |
| [Artifact registry][registry] | Where each artifact type lives and the next version |
| [Framework README][framework-readme] | The framework this project uses |
| [Framework changelog][framework-changelog] | What changed in each framework release |
---
[repository]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/024-mail-merge
[documentation]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/024-mail-merge/wiki
[issues]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/024-mail-merge/issues
[license]: ./LICENSE
[agents]: ./AGENTS.md
[registry]: ./docs/artifact-registry.md
[framework-readme]: ./framework/README.md
[framework-changelog]: ./framework/CHANGELOG.md