Skip to content

Commit

Permalink
Merge pull request OpenGovAus#10 from KipCrossing/Updatereadme
Browse files Browse the repository at this point in the history
Updatereadmeplz
  • Loading branch information
KipCrossing authored Mar 20, 2020
2 parents f295ca7 + 44ef3dd commit 93338bf
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 16 deletions.
2 changes: 2 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ workflows:
filters:
tags:
only: /[0-9]+(\.[0-9]+)*/
branches:
only: master

jobs:
build:
Expand Down
39 changes: 23 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,6 @@ Current governments that are supported:

- Australian Federal Government

## Contributing

We use **BeautifulSoup** to scrape the bills from the Bills websites. so make sure you become familiar with the docs [here](https://www.crummy.com/software/BeautifulSoup/bs4/doc/).

Fork the repo and install requirements

```
pip3 install -r requirements.txt
```

Each state should their own bills and corresponding website. Add a python file for a new state in the /ausbills dir. the python file should have the naming convention: [`wa_parliment.py`](ausbills/wa_parliment.py) for [_Western Australia_](https://www.parliament.wa.gov.au/parliament/bills.nsf/screenWebCurrentBills) for example. Make sure we all agree on method/object/output conventions (use federal_bills as a guide). Once you are happy, update the README on method usage and make a Pull Request.


```
git tag -a v0.0.8 -m "update version 0.0.8"
```


## Australian Federal Government
Expand Down Expand Up @@ -64,6 +48,29 @@ and you can get the data dump as a dict:
bill.data
```

## Contributing

We use **BeautifulSoup** to scrape the bills from the Bills websites. so make sure you become familiar with the docs [here](https://www.crummy.com/software/BeautifulSoup/bs4/doc/).

Fork the repo and install requirements

```
pip3 install -r requirements.txt
```

Each state should their own bills and corresponding website. Add a python file for a new state in the /ausbills dir. the python file should have the naming convention: [`wa_parliment.py`](ausbills/wa_parliment.py) for [_Western Australia_](https://www.parliament.wa.gov.au/parliament/bills.nsf/screenWebCurrentBills) for example. Make sure we all agree on method/object/output conventions (use federal_bills as a guide). Once you are happy, update the README on method usage and make a Pull Request.

#### Upgrade package

Change VERSION in [setup.py](setup.py), then:

```
git tag -a 0.1.0 -m "update version 0.1.0"
git push -d origin 0.1.0
```



### Todo

- get second reading debate links
Expand Down

0 comments on commit 93338bf

Please sign in to comment.