https://github.com/dadananjesha/twitter-search-api
A minimum viable product written in Python using Django and the Django REST Framework with a sqlite database.
https://github.com/dadananjesha/twitter-search-api
django-application django-rest-framework dockerfile mvp mvt-architecture python3 sql sqlite3 twitter-api
Last synced: 2 months ago
JSON representation
A minimum viable product written in Python using Django and the Django REST Framework with a sqlite database.
- Host: GitHub
- URL: https://github.com/dadananjesha/twitter-search-api
- Owner: DadaNanjesha
- License: mit
- Created: 2021-02-26T21:00:58.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-11T20:19:39.000Z (over 1 year ago)
- Last Synced: 2026-01-11T20:40:58.063Z (5 months ago)
- Topics: django-application, django-rest-framework, dockerfile, mvp, mvt-architecture, python3, sql, sqlite3, twitter-api
- Language: Python
- Homepage:
- Size: 98.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Twitter Search API (Django project)
A **lightweight and efficient** Twitter Search API built with **Python, Django, and Django REST Framework**. This project utilizes the **Twitter Search API** to fetch, store, filter, and export tweets related to trending events and hashtags.
---
## 🚀 Features
- 🔍 **Search Twitter** - Fetch recent tweets based on trending hashtags or keywords.
- 🗄️ **Store & Retrieve** - Save tweets into a local SQLite database and retrieve them with flexible filtering options.
- 📤 **Export to CSV** - Export tweet data in CSV format for analysis.
- 🖥️ **REST API Endpoints** - Easily interact with tweet data using well-structured API endpoints.
---
## 📌 API Endpoints
### 1️⃣ **Trigger a Twitter Search**
Fetch tweets for high-traffic hashtags.
```bash
GET /search/?query=YourSearchQuery
```
**Example:** `http://127.0.0.1:8000/search/?query=ElectionDay`
### 2️⃣ **Retrieve Stored Tweets**
Fetch tweets stored in the database with optional filtering.
```bash
GET /twitterSearch/
GET /twitterSearch/?search=YourKeyword
```
**Example:** `http://127.0.0.1:8000/twitterSearch/?search=ko`
### 3️⃣ **Export Tweets to CSV**
Export stored tweets to CSV, selecting relevant columns.
```bash
GET /twitterDataExport/
```
**Example:** `http://127.0.0.1:8000/twitterDataExport/`
---
## 📂 Project Structure
---
## 🛠️ Installation
1️⃣ **Clone the Repository**
```bash
git clone https://github.com/yourusername/twitter-search-api.git
cd twitter-search-api
```
2️⃣ **Create & Activate Virtual Environment**
```bash
python -m venv env
source env/bin/activate # On Windows use `env\Scripts\activate`
```
3️⃣ **Install Dependencies**
```bash
pip install -r requirements.txt
```
4️⃣ **Run Database Migrations**
```bash
python manage.py migrate
```
5️⃣ **Start the Development Server**
```bash
python manage.py runserver
```
---
## ⚙️ Environment Variables
To connect to Twitter API, set up the following environment variables:
```bash
TWITTER_API_KEY=
TWITTER_API_SECRET_KEY=
TWITTER_ACCESS_TOKEN=
TWITTER_ACCESS_TOKEN_SECRET=
```
---
## 🧪 Running Tests
Run the test suite to verify functionality:
```bash
python manage.py test
```
---
## 🤝 Contributions
We welcome contributions! 🎉 To contribute:
- Fork the repository.
- Create a new branch.
- Implement your changes.
- Submit a pull request.
Ensure that your code is well-documented and includes relevant tests.
---
## ⭐️ Call-to-Action
If you find this project helpful, please consider:
- **Starring** the repository to show your support.
- **Forking** to contribute improvements.
- **Following** for updates on future projects.
Your engagement helps boost visibility and encourages further collaboration!
---
## 📝 License
This project is licensed under the [MIT License](LICENSE).
---
💙 **Happy Coding!** 🚀