Skip to content

Commit 5511b2c

Browse files
committed
Updated .gitignore and README.md.
1 parent 045fa98 commit 5511b2c

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ run.py
88
checker_output*
99
/_scripts/
1010
/build/
11-
/dist/
11+
/dist/
12+
/*.egg-info/

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,18 @@ MISOReports supports these features and more:
1717
- Downloading raw report content in any of their supported formats (csv, xml, json, xls, xlsx, etc.)
1818
- Generating target URLs for the report of your choice
1919

20+
## Installation
21+
To install and use MISOReports, in the command line, run:
22+
```
23+
pip install MISOReports
24+
```
25+
2026
## Examples
2127

2228
### Example 1:
2329
Download a single-table report with datetime option from [MISO Market Reports](https://www.misoenergy.org/markets-and-operations/real-time--market-data/market-reports/).
2430

25-
#### Input:
31+
#### Code:
2632
```python
2733
import datetime
2834
from MISOReports.MISOReports import MISOReports
@@ -71,7 +77,7 @@ print(df)
7177
### Example 2:
7278
Download a multi-table report from [MISORTWDDataBroker](https://api.misoenergy.org/MISORTWDDataBroker/).
7379

74-
#### Input:
80+
#### Code:
7581
```python
7682
from MISOReports.MISOReports import MISOReports
7783

@@ -116,7 +122,7 @@ FiveMinTotalLoad
116122
### Example 3:
117123
Download a multi-table report from [MISORTWDDataBroker](https://api.misoenergy.org/MISORTWDDataBroker/).
118124

119-
#### Input:
125+
#### Code:
120126
```python
121127
from MISOReports.MISOReports import MISOReports
122128

@@ -156,7 +162,7 @@ Data
156162
### Example 4:
157163
Download a single-table report along with its text content from [MISO Market Reports](https://www.misoenergy.org/markets-and-operations/real-time--market-data/market-reports/).
158164

159-
#### Input:
165+
#### Code:
160166
```python
161167
from MISOReports.MISOReports import MISOReports
162168

@@ -192,7 +198,7 @@ Dataframe:
192198
### Example 5:
193199
Download a single-table report with datetime option from [MISO Market Reports](https://www.misoenergy.org/markets-and-operations/real-time--market-data/market-reports/).
194200

195-
#### Input:
201+
#### Code:
196202
```python
197203
import datetime
198204
from MISOReports.MISOReports import MISOReports

0 commit comments

Comments
 (0)