Skip to content

Commit

Permalink
#1: updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
josuebrunel committed Jul 8, 2015
1 parent ee274e6 commit 720f33f
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 17 deletions.
24 changes: 24 additions & 0 deletions docs/stockscraper.md
Original file line number Diff line number Diff line change
Expand Up @@ -460,6 +460,30 @@ data = stocks.get_dividendhistory('AAPL',"2008-01-01", "2015-06-15")

```

#### *StockRetriever.get_balancesheet(symbol)*

```python
from myql.contrib.finance.stockscraper import StockRetriever
stocks = StockRetriever(format='json')
data = self.stock.get_balancesheet('YHOO')
```

```json
{
"query": {
"count": 1,
"created": "2015-07-08T09:01:12Z",
"lang": "en-US",
"results": {
"balancesheet": {
"symbol": "YHOO",
"timeframe": "quarterly"
}
}
}
}
```

#### *StockRetriever.get_symbols(company_name)*

     **Always returns data as JSON**
Expand Down
25 changes: 8 additions & 17 deletions docs/weather.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Weater
* ***kwargs*** : Any possible argument of **YQL**

```python
>>> from myql.contrib.weather import Weather
>>> weather = Weather(unit='c', format='json')
from myql.contrib.weather import Weather
weather = Weather(unit='c', format='json')
```


Expand All @@ -20,7 +20,7 @@ Weater
>Return weather information according to the place passed in
```python
>>> data = weather.get_weather_in('choisy-le-roi', 'c',['location', 'units', 'item.condition'])
data = weather.get_weather_in('choisy-le-roi', 'c',['location', 'units', 'item.condition'])
```

```json
Expand Down Expand Up @@ -141,7 +141,7 @@ Weater
>Return weather forecast
```python
>>> data = weather.get_weather_description('dolisie')
data = weather.get_weather_description('dolisie')
```

```json
Expand All @@ -164,20 +164,11 @@ Weater

```

#### *Weather.get_current_condition(place)*
>get_current_condition
```python
```

```json
```

#### *Weather.get_current_atmosphere(place)*
>Return weather atmosphere
```python
>>> data = weather.get_current_condition('Nantes')
data = weather.get_current_condition('Nantes')
```

```json
Expand Down Expand Up @@ -238,7 +229,7 @@ Weater
>Return sunrise and sunset time
```python
>>> data = weather.get_current_atmosphere('Scotland')
data = weather.get_current_atmosphere('Scotland')
```

```json
Expand Down Expand Up @@ -340,7 +331,7 @@ Weater
>Return weather wind
```python
>>> data = weather.get_current_wind('Barcelona')
data = weather.get_current_wind('Barcelona')
```

```json
Expand Down Expand Up @@ -411,7 +402,7 @@ Weater
>Return sunrise and sunset time
```python
>>> data = weather.get_astronomy('Congo')
data = weather.get_astronomy('Congo')
```

```json
Expand Down

0 comments on commit 720f33f

Please sign in to comment.