mirror of
https://github.com/aljazceru/IngestRSS.git
synced 2026-02-05 22:34:23 +01:00
fixed lambda package error and todo.md
This commit is contained in:
Charles E. Gormley
@@ -52,7 +52,7 @@ The primary goal of IngestRSS is to provide researchers with a robust, scalable
|
||||
|
||||
## 🛠️ Configuration
|
||||
|
||||
- RSS feeds can be modified in the `rss_feeds.json` file.
|
||||
- **RSS feeds can be modified in the `rss_feeds.json` file.**
|
||||
- CloudFormation templates are located in `src/infra/cloudformation/`.
|
||||
- Lambda function code is in `src/lambda_function/src/`.
|
||||
|
||||
|
||||
119
todo.md
119
todo.md
@@ -1,102 +1,33 @@
|
||||
# 🚀 IngestRSS - 🗞️💵⚖️
|
||||
# TODO Before Launch 🚀
|
||||
* Delete KMS KEY test.
|
||||
* Fix lambda error with pacakges.
|
||||
* Test from 3rd party aws account.
|
||||
|
||||
|
||||
|
||||
IngestRSS is an AWS-based RSS feed processing system that automatically fetches, processes, and stores articles from specified RSS feeds. This project is designed to support social scientists in progressing research on news and media.
|
||||
# Misc TODO:
|
||||
* More RSS Feed Module - Easy
|
||||
* Add in console setup python script for new project into launch.py
|
||||
|
||||
## 🎯 Purpose
|
||||
|
||||
The primary goal of IngestRSS is to provide researchers with a robust, scalable solution for collecting and analyzing large volumes of news data. By automating the process of gathering articles from diverse sources, this tool enables social scientists to focus on their research questions and data analysis, rather than the complexities of data collection.
|
||||
|
||||
## 🚀 Getting Started
|
||||
# Next Modules
|
||||
* Vector Database Storage Solution w/ Pinecone.
|
||||
* Gen AI Summarization Module.
|
||||
* Duplicate Article Check Module.
|
||||
* Github Issues & Github Actions.
|
||||
|
||||
### Prerequisites
|
||||
# Future Modules
|
||||
* Other Add-on's with text classification of articles ( Sentiment Analysis, political polarity, etc... )
|
||||
* Article Clustering Module
|
||||
* API Module ( Semantic Search, Retrieval )
|
||||
* Architecture Diagram
|
||||
|
||||
- Python 3.12
|
||||
- AWS account with necessary permissions
|
||||
- AWS CLI configured with your credentials
|
||||
# Possible Use Cases/Examples
|
||||
* Betting Market Prediction
|
||||
* Financial Market Predicitions
|
||||
* News Aggregation
|
||||
* News Letter Tooling
|
||||
|
||||
### Setup
|
||||
|
||||
1. Clone the repository:
|
||||
```
|
||||
git clone https://github.com/yourusername/IngestRSS.git
|
||||
cd IngestRSS
|
||||
```
|
||||
|
||||
2. Install required packages:
|
||||
```
|
||||
python -m pip install -r requirements.txt
|
||||
```
|
||||
|
||||
3. Set up your environment variables:
|
||||
- Find the file named `template.env` in your folder.
|
||||
- Make a copy of this file in the same folder.
|
||||
- Rename the copy to `.env` (make sure to include the dot at the start).
|
||||
- Open the `.env` file and fill in your information where you see `***`.
|
||||
|
||||
Here's what you need to fill in:
|
||||
```
|
||||
AWS_REGION=***
|
||||
AWS_ACCOUNT_ID=***
|
||||
AWS_ACCESS_KEY_ID=***
|
||||
AWS_SECRET_ACCESS_KEY=***
|
||||
```
|
||||
|
||||
The other settings in the file are already set up for you, but you can change them if you need to.
|
||||
|
||||
4. Launch the application:
|
||||
```
|
||||
python launch.py
|
||||
```
|
||||
|
||||
## 🛠️ Configuration
|
||||
|
||||
- RSS feeds can be modified in the `rss_feeds.json` file.
|
||||
- CloudFormation templates are located in `src/infra/cloudformation/`.
|
||||
- Lambda function code is in `src/lambda_function/src/`.
|
||||
|
||||
## 📊 Monitoring
|
||||
|
||||
The Lambda function logs its activities to CloudWatch Logs. You can monitor the function's performance and any errors through the AWS CloudWatch console.
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
We welcome contributions! Please feel free to submit a Pull Request.
|
||||
|
||||
## 📄 License
|
||||
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## 📁 Project Structure
|
||||
|
||||
```
|
||||
CHANGELOG.md
|
||||
├── CONTRIBUTING.md
|
||||
├── README.md
|
||||
├── launch.py
|
||||
├── requirements.txt
|
||||
├── rss_feeds.json
|
||||
├── src
|
||||
│ ├── article_storage
|
||||
│ ├── feed_management
|
||||
│ ├── infra
|
||||
│ │ ├── cloudformation
|
||||
│ │ ├── lambdas
|
||||
│ │ │ ├── RSSFeedProcessorLambda
|
||||
│ │ │ ├── RSSQueueFiller
|
||||
│ │ │ └── lambda_utils
|
||||
│ ├── launch
|
||||
│ └── utils
|
||||
├── template.env
|
||||
├── tmp
|
||||
├── todo.md
|
||||
├── tree.md
|
||||
└── wallpaper.png
|
||||
```
|
||||
|
||||
## 🙏 Acknowledgements
|
||||
|
||||
This project is made possible thanks to the contributions of researchers and developers committed to advancing the field of media studies and social science research.
|
||||
# Over-caffeineted Ideas ☕
|
||||
* Make it solarpunk themed.
|
||||
* Write a serverless manifesto for personal projects and where you would like to see the serverless world go.
|
||||
Reference in New Issue
Block a user