Skip to content
This repository has been archived by the owner on Sep 17, 2022. It is now read-only.

Commit

Permalink
README format
Browse files Browse the repository at this point in the history
  • Loading branch information
Latif committed Aug 22, 2020
1 parent 589f740 commit 68b34df
Showing 1 changed file with 3 additions and 10 deletions.
13 changes: 3 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
## Amwal - Unofficial API For the Kuwaiti Stock Market (Boursa)

---

Amwal is a small python library designed to make it easier to get information from the Kuwaiti stock market, known as the Boursa. Unfortunately, since the Boursa website doesn't have an official HTTP API, this is a substitute that offers the same function by scraping the website directly for the data.

---
Expand All @@ -14,7 +12,7 @@ Some features to make life easier

---

### Quick start
## Quick start

The main class representing the market as a whole is `amwal.Market`. For example, to get the companies listed on the Boursa:

Expand Down Expand Up @@ -45,8 +43,6 @@ yearly_income = zain.yearly_income()
```
It's pretty straightforward

---

## Notes

#### Cache
Expand Down Expand Up @@ -82,10 +78,7 @@ Pandas has many useful functions to serialize dataframes, or to convert from a d

You can get some output by passing a `verbose=True` argument to the scraping functions.


---

API
## API

```python
class Market(cache_path='amwal_cache', downloader=SyncDownloader) -> Market
Expand Down Expand Up @@ -114,7 +107,7 @@ class Corporation (ident: str, market: Market, **kwargs)

---

TODO:
### TODO:

- Add balance sheet and cash flow statement methods to the corporation class.
- Change scraping to be asynchronously.
Expand Down

0 comments on commit 68b34df

Please sign in to comment.