promptotype-letters
Science Score: 57.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 2 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.2%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: martinascholger
- Language: Python
- Default Branch: main
- Size: 452 KB
Statistics
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
Letters Promptotype
A Flask-based prototype for letter editions, employing DH Craft’s Promptotyping methodology.
This project serves as a promptotype—a prototype developed using AI-assisted prompt engineering—designed to facilitate the exploration and visualization of letter corpora in a structured XML TEI format.
Overview
The app provides: - a list of letters with status labels. - access to a single-letter view with multiple tabs: - Original text - Translation (if available) - TEI/XML Code view - Basic metadata - a timeline showing when letters were sent.
Data Sources
Currently, the prototype is based on letters from the Joseph von Hammer-Purgstall digital letter edition (coming soon on http://gams.uni-graz.at/hpe. However, the data can be replaced with letters from the Hugo Schuchardt Archive http://schuchardt.uni-graz.at (available in the schuchardt-data folder). Simply replace the dataset in the data/ folder and restart the app.
License:
The letter data and the app is licensed under Creative Commons BY-NC 4.0.
Technical Details
- Framework: Flask (Python)
- Hosting: Render.com
- Frontend: HTML, Bootstrap5
- Data Storage: JSON-based
- Dynamic Data Sources: Can be adapted to different letter collections with similar structure.
- Scalability: Successfully tested with ~500 letters.
How to Run Locally
Clone the Repository
sh
git clone https://github.com/martinascholger/promptotype-letters.git
cd promptotype-letters/letters
Install Dependencies
sh
pip install -r requirements.txt
Run the Flask App
sh
python app.py
By default, the app runs at http://127.0.0.1:5000/.
Live Deployment
The app is deployed on Render.com, and the latest version can be accessed at: Live App URL
🔧 Development Process
The app was developed using Promptotyping, following these stages:
1. Prompt Engineering
- Designed structured prompts for AI-assisted interface generation using Claude 3.5 Sonnet & ChatGPT o1. See more on DH Craft’s Promptotyping Process Guidelines.
2. Setup & Environment
- Flask backend with JSON data storage.
3. Refinement
- Improved individual views (list view, letter detail, metadata, timeline).
Extending the Prototype
- Replace the data folder with other TEI-structured letters (e.g., from the Hugo Schuchardt Archive).
- Modify the Flask routes to adjust views.
- Implement additional filters for letter sorting and search.
Citation
To cite this project in your research, please refer to the CITATION.cff file. You can also use GitHub's citation feature by clicking on the "Cite this repository" button on our GitHub page.
References
Hurch, Bernhard (Hrsg.): Hugo Schuchardt Archiv. Graz: Institut für Sprachwissenschaft, Universität Graz. 2022. URL: http://schuchardt.uni-graz.at.
Höflechner, Walter; Scholger, Martina; Wagner Alexandra (Hrsg.) 2025: Joseph von Hammer-Purgstall. Korrespondenz. Graz. URL: https://gams.uni-graz.at/hpe (forthcoming).
Steiner, Christian / Pollin, Christopher (2024): Promptotyping: AI-Enhanced Rapid Prototyping for Data-Driven Applications. https://github.com/DigitalHumanitiesCraft/excellence/tree/main/promptotyping
Steiner, Christian, / Pollin, Christopher (2024): Promptotyping (v1.0.0). Zenodo. https://doi.org/10.5281/zenodo.14160876
Owner
- Name: Martina Scholger
- Login: martinascholger
- Kind: user
- Location: Graz
- Company: Center for Information Modelling
- Repositories: 1
- Profile: https://github.com/martinascholger
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: Letters Promptotype
message: 'If you use this app, please cite it as given below.'
type: software
authors:
- given-names: Martina
family-names: Scholger
email: martina.scholger@uni-graz.at
affiliation: University of Graz
orcid: 'https://orcid.org/0000-0003-1438-3236'
- given-names: Elisabeth
family-names: Steiner
email: elisabeth.steiner@uni-graz.at
affiliation: University of Graz
orcid: 'https://orcid.org/0000-0001-9116-0402'
repository-code: 'https://github.com/martinascholger/promptotype-letters'
abstract: >-
Promptotype of TEI encoded letters - a preview prototype
developed using AI-assisted prompt engineering,
facilitating the exploration and visualization of letter
corpora. Based on DH Craft’s Promptotyping methodology:
https://github.com/DigitalHumanitiesCraft/excellence/tree/v1.0.0/promptotyping.
keywords:
- promptotyping
- TEI
- letter edition
- digital humanities
license: CC-BY-NC-4.0
version: 1.0.0
date-released: '2025-02-12'
GitHub Events
Total
- Watch event: 2
- Push event: 4
- Create event: 1
Last Year
- Watch event: 2
- Push event: 4
- Create event: 1
Dependencies
- Flask ==3.1.0
- Jinja2 ==3.1.5
- MarkupSafe ==3.0.2
- Werkzeug ==3.1.3
- blinker ==1.9.0
- click ==8.1.8
- colorama ==0.4.6
- gunicorn ==23.0.0
- itsdangerous ==2.2.0
- lxml ==5.3.0
- numpy ==2.2.2
- packaging ==24.2
- pandas ==2.2.3
- python-dateutil ==2.9.0.post0
- pytz ==2025.1
- six ==1.17.0
- tzdata ==2025.1