https://github.com/areed1192/python-for-starters
A guide on how to get up and running with Python, VSCode, Git, & GitHub on Windows.
https://github.com/areed1192/python-for-starters
Last synced: 2 months ago
JSON representation
A guide on how to get up and running with Python, VSCode, Git, & GitHub on Windows.
- Host: GitHub
- URL: https://github.com/areed1192/python-for-starters
- Owner: areed1192
- License: mit
- Created: 2021-03-19T00:07:24.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-23T00:18:39.000Z (about 2 years ago)
- Last Synced: 2025-03-21T15:42:29.198Z (3 months ago)
- Language: Python
- Size: 45.9 KB
- Stars: 3
- Watchers: 1
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Energy Feed Scraper
## Table of Contents
- [Overview](#overview)
- [Setup](#setup)
- [Usage](#usage)
- [Support These Projects](#support-these-projects)
## Overview
This library will help capture different articles from the EPA RSS feeds. Additionally
it will help us send emails once the data is capture.
## Setup
**Setup - Requirements Install:**
For this particular project, you only need to install the dependencies, to use the project. The dependencies
are listed in the `requirements.txt` file and can be installed by running the following command:
```console
pip install -r requirements.txt
```
After running that command, the dependencies should be installed.
**Setup - Local Install:**
If you are planning to make modifications to this project or you would like to access it
before it has been indexed on `PyPi`. I would recommend you either install this project
in `editable` mode or do a `local install`. For those of you, who want to make modifications
to this project. I would recommend you install the library in `editable` mode.
If you want to install the library in `editable` mode, make sure to run the `setup.py`
file, so you can install any dependencies you may need. To run the `setup.py` file,
run the following command in your terminal.
```console
pip install -e .
```
If you don't plan to make any modifications to the project but still want to use it across
your different projects, then do a local install.
```console
pip install .
```
This will install all the dependencies listed in the `setup.py` file. Once done
you can use the library wherever you want.
## Usage
Here is a simple example of using the `energy_feed` library.
```python
from pprint import pprint
from energy_feed.enums import Months
from energy_feed.client import EnergyFeedClient
# Initialize the client.
scraper_client = EnergyFeedClient()
# Initialize the `NewsFeed` service.
news_feed_service = scraper_client.news_feed()
# Grab the Articles for the month of April.
pprint(news_feed_service.today_in_energy(month='Apr', year=2021))
# Grab another month but this time use the enums.
pprint(news_feed_service.today_in_energy(month=Months.December, year=2020))
```
## Support These Projects
**Patreon:**
Help support this project and future projects by donating to my [Patreon Page](https://www.patreon.com/sigmacoding). I'm
always looking to add more content for individuals like yourself, unfortuantely some of the APIs I would require me to
pay monthly fees.
**YouTube:**
If you'd like to watch more of my content, feel free to visit my YouTube channel [Sigma Coding](https://www.youtube.com/c/SigmaCoding).
**Questions:**
If you have questions please feel free to reach out to me at [[email protected]](mailto:[email protected]?subject=[GitHub]%20Fred%20Library)