folder upload

#1
by rishipal - opened
Files changed (2) hide show
  1. Readme.md +109 -124
  2. contributing.md +18 -18
Readme.md CHANGED
@@ -1,124 +1,109 @@
1
- ---
2
- title: WikiTales
3
- emoji: πŸ“š
4
- colorFrom: indigo
5
- colorTo: pink
6
- sdk: streamlit
7
- sdk_version: "1.35.0"
8
- app_file: app.py
9
- pinned: false
10
- ---
11
- # πŸ“– WikiTales – Interactive Historical Storybooks
12
-
13
- > WikiTales is an open-source, story-driven web app that transforms raw historical data from Wikimedia projects into immersive, engaging storybook-style narratives. Built with Python and Streamlit, it’s designed to help learners explore the past like never before.
14
-
15
- ---
16
-
17
- ## Team Members
18
- - Rishi Palavarapu
19
- - Harsha Ambati
20
- - Rishitha Reddy
21
- - Yaswanth Ambati
22
-
23
- ---
24
-
25
- ## πŸš€ Overview
26
-
27
- WikiTales bridges storytelling and research by compiling content from **Wikimedia public APIs** such as Wikipedia, Wikiquote, Wikidata, Wikisource, Wikibooks, and more. It generates narrative summaries, trivia facts, quotes, timelines, and glossary definitions based on user-entered topics.
28
-
29
- ---
30
-
31
- ## πŸ” Key Features
32
-
33
- - 🧠 **AI-generated Story Narratives** based on historical events and figures
34
- - 🎭 **Narrator Styles**: Choose between historian, eyewitness, journalist, AI assistant, etc.
35
- - 🧾 **Dynamic Timelines** of important events
36
- - πŸ’¬ **Quotes & Primary Sources** from Wikiquote and Wikisource
37
- - 🧠 **β€œDid You Know?” Facts** from Wikidata
38
- - πŸ“š **Wikibooks Sidebar** for extended learning material
39
- - πŸ“Έ **Image Carousel** using Wikimedia Commons
40
-
41
- ---
42
-
43
- ## πŸ› οΈ Built With
44
-
45
- - **Frontend & UI**: [Streamlit](https://streamlit.io/)
46
- - **Language**: Python 3.10+
47
- - **Data Sources**:
48
- - [Wikipedia API](https://en.wikipedia.org/w/api.php)
49
- - [Wikidata API](https://www.wikidata.org/w/api.php)
50
- - [Wikibooks API](https://en.wikibooks.org/w/api.php)
51
- - [Wikiquote API](https://en.wikiquote.org/w/api.php)
52
- - [Wiktionary API](https://en.wiktionary.org/w/api.php)
53
- - [Wikisource API](https://en.wikisource.org/w/api.php)
54
- - [Wikimedia Commons API](https://commons.wikimedia.org/w/api.php)
55
-
56
- ---
57
-
58
- ## βš™οΈ How It Works
59
-
60
- 1. **User enters a topic** (e.g. *World War II*).
61
- 2. WikiTales fetches:
62
- - Summary from Wikipedia
63
- - Quotes from Wikiquote
64
- - Timeline from Wikidata
65
- - Definitions from Wiktionary
66
- - Images from Commons
67
- - Source documents from Wikisource
68
- - Related books from Wikibooks
69
- 3. Story is narrated using the selected voice and formatted as a storybook.
70
- 4. Additional enhancements include interactive glossary and image carousel.
71
-
72
- ---
73
-
74
- ## πŸ”§ Setup Instructions
75
-
76
- To get started with this project, follow these steps:
77
-
78
- ```bash
79
- # Clone the repository
80
- git clone https://code.swecha.org/soai2025/soai-hackathon/team-titans.git
81
-
82
- # Navigate to the project folder
83
- cd team-titans
84
-
85
- # (Optional but recommended) Create a virtual environment
86
- python3 -m venv wikitales_venv
87
- source wikitales_venv/bin/activate
88
-
89
- # Install dependencies
90
- pip install -r requirements.txt
91
-
92
- # Run the app locally
93
- streamlit run app.py
94
- ```
95
-
96
- ---
97
-
98
- ### πŸš€ Deployment
99
-
100
- This app is designed to be deployed on [Hugging Face Spaces](https://huggingface.co/spaces) using the **Streamlit template**.
101
-
102
- ---
103
-
104
- ### πŸ—‚οΈ Project Structure
105
-
106
- ```
107
- WikiTales/
108
- β”œβ”€β”€ app.py # Main Streamlit app
109
- β”œβ”€β”€ requirements.txt # Python dependencies
110
- β”œβ”€β”€ README.md # Project overview and setup
111
- β”œβ”€β”€ story_engine/ # All logic modules for fetching and generating story content
112
- β”‚ β”œβ”€β”€ __init__.py
113
- β”‚ β”œβ”€β”€ wikipedia.py
114
- β”‚ β”œβ”€β”€ wikiquote.py
115
- β”‚ β”œβ”€β”€ wikisource.py
116
- β”‚ β”œβ”€β”€ commons.py
117
- β”‚ β”œβ”€β”€ wikidata.py
118
- β”‚ β”œβ”€β”€ wikibooks.py
119
- β”‚ β”œβ”€β”€ formatter.py
120
- β”‚ └── story_builder.py # Core function to build story from APIs
121
-
122
- ```
123
-
124
- > πŸ“ `story_engine/` contains modular Python files to keep the logic clean and testable.
 
1
+ # πŸ“š WikiSage – All Wiki Resources for a Topic
2
+
3
+ > πŸ” One Topic. All Wiki. Your Way.
4
+
5
+ ## Team Members
6
+ - Rishi Palavarapu
7
+ - Harsha Ambati
8
+ - Rishitha Reddy
9
+ - Yaswanth Ambati
10
+
11
+ ## 🧠 Overview
12
+
13
+ **WikiSage** is a smart, educational app built for the WikiVerse Hackathon. It allows users to explore **comprehensive information about any topic** by aggregating and organizing resources from across Wikimedia projects like Wikipedia, Wikibooks, Wikiquote, Commons, Wikisource, and more β€” all in one place.
14
+
15
+ ---
16
+
17
+ ## 🎯 Problem Statement
18
+
19
+ Millions of users rely on Wikimedia for learning, but navigating multiple platforms (Wikipedia, Wikibooks, Wikiquote, etc.) to gather full information on a single topic is **time-consuming and fragmented**.
20
+
21
+ There is no unified platform that allows learners to:
22
+
23
+ - Seamlessly explore all types of Wikimedia content (articles, books, quotes, images, source texts) on **one topic**
24
+ - **Access diverse formats of learning content** (definitions, timelines, media, references)
25
+ - Interact with this knowledge in a structured, multilingual, and accessible way
26
+
27
+ ---
28
+
29
+ ## πŸ’‘ Solution
30
+
31
+ **WikiSage** solves this by:
32
+ - Fetching content from multiple Wikimedia public APIs
33
+ - Structuring them into an intuitive, topic-based interface
34
+ - Providing features like multilingual support, content export, and related topic mapping
35
+
36
+ ---
37
+
38
+ ## πŸš€ Features
39
+
40
+ | Feature | Description |
41
+ |--------|-------------|
42
+ | πŸ” **Smart Topic Search** | User inputs a topic (e.g., "Quantum Physics", "Mahatma Gandhi") |
43
+ | πŸ“„ **Knowledge Summary** | Summary and detailed content from Wikipedia |
44
+ | πŸ“š **In-Depth Books** | Structured reading material from Wikibooks |
45
+ | πŸ’¬ **Famous Quotes** | Related quotes using Wikiquote |
46
+ | πŸ“œ **Primary Sources** | Historical documents from Wikisource |
47
+ | πŸ–ΌοΈ **Media Gallery** | Relevant images from Commons |
48
+ | 🧠 **Linked Topics Map** | Visual exploration of related topics via Wikidata |
49
+ | 🌐 **Multilingual Mode** | Pulls topic info in different languages via Wikimedia APIs |
50
+ | πŸ“₯ **Export Feature** | Download topic summary as PDF or Markdown |
51
+
52
+ ---
53
+
54
+ ## 🌐 APIs Used
55
+
56
+ All APIs are strictly from the list approved in the [WikiVerse Hackathon Guidelines](#):
57
+
58
+ | API | Purpose |
59
+ |-----|---------|
60
+ | Wikipedia (`en.wikipedia.org`) | Topic summaries & articles |
61
+ | Wikibooks (`en.wikibooks.org`) | Educational book modules |
62
+ | Wikisource (`en.wikisource.org`) | Primary documents |
63
+ | Wikiquote (`en.wikiquote.org`) | Famous quotes |
64
+ | Commons (`commons.wikimedia.org`) | Media assets (images, posters, etc.) |
65
+ | Wiktionary (`en.wiktionary.org`) | Definitions and multilingual word meanings |
66
+ | Wikidata (`www.wikidata.org`) | Related concepts and metadata |
67
+
68
+ ---
69
+
70
+ ## 🎯 Target Users
71
+
72
+ - πŸ“˜ Students researching a subject
73
+ - 🧠 Self-learners exploring a new topic
74
+ - πŸ‘¨β€πŸ« Educators curating study content
75
+ - πŸ“° Content creators/fact-checkers
76
+ - 🌍 Anyone interested in structured, verified knowledge
77
+
78
+ ---
79
+
80
+ ## πŸ› οΈ Tech Stack
81
+
82
+ - **Frontend**: HTML, CSS, JavaScript / React (choose based on final implementation)
83
+ - **Backend**: Node.js / Python (for API integration & routing)
84
+ - **APIs**: RESTful calls to Wikimedia APIs
85
+ - **Hosting**: GitLab Pages / Local, Streamlit Cloud
86
+
87
+ ---
88
+
89
+ ## πŸ“¦ Project Structure
90
+ | Hour | Phase | Tasks |
91
+ |------|-------------------------------|-----------------------------------------------------------------------|
92
+ | 1 | *Ideation & Planning* | Define app scope, identify APIs needed, finalize features, assign tasks |
93
+ | 2 | *UI/UX & Architecture* | Design layout, multilingual UI, API-client separation, wireframes |
94
+ | 3-5 | *Development Phase* | Build Python backend (API wrappers for Wikipedia, Commons, Wikidata) <br> Build frontend with search UI + display views <br> Integrate AI model for summarization |
95
+ | 6 | *Testing* | Test multilingual search, output display, and error handling |
96
+ | 7 | *Deployment & Refinement* | Final fixes, improve UI, connect frontend to backend APIs |
97
+ | 8 | *Documentation & Pitch Prep*| Finalize README, prepare 5-minute demo and presentation |
98
+
99
+
100
+ ---
101
+
102
+
103
+ ## πŸ“– How to Run Locally
104
+
105
+ ```bash
106
+ git clone https://gitlab.com/your-team/wiki-sage.git
107
+ cd wiki-sage
108
+ npm install
109
+ npm start
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
contributing.md CHANGED
@@ -1,18 +1,18 @@
1
- # 🀝 Contributing to WikiSage
2
-
3
- Welcome to the WikiSage project β€” an open knowledge app built for the WikiVerse Hackathon.
4
- We’re glad you want to help make it better! 🧠
5
-
6
- Please follow these guidelines to ensure clean, stable, and collaborative development
7
-
8
- ---
9
-
10
- ## πŸ”§ Setup Instructions
11
-
12
- To get started:
13
-
14
- 1. **Clone the repository**:
15
-
16
- ```bash
17
- git clone https://gitlab.com/your-team/wiki-sage.git
18
- cd wiki-sage
 
1
+ # 🀝 Contributing to WikiSage
2
+
3
+ Welcome to the WikiSage project β€” an open knowledge app built for the WikiVerse Hackathon.
4
+ We’re glad you want to help make it better! 🧠
5
+
6
+ Please follow these guidelines to ensure clean, stable, and collaborative development.
7
+
8
+ ---
9
+
10
+ ## πŸ”§ Setup Instructions
11
+
12
+ To get started:
13
+
14
+ 1. **Clone the repository**:
15
+
16
+ ```bash
17
+ git clone https://gitlab.com/your-team/wiki-sage.git
18
+ cd wiki-sage