Metadata-Version: 2.1
Name: ausbills
Version: 0.4.0
Summary: Get current parliament bills from Australian governments.
Home-page: https://github.com/KipCrossing/Aus-Bills
Author: Kipling Crossing
Author-email: kip.crossing@gmail.com
License: UNKNOWN
Description: # Aus Bills
        
        This is a package is for obtaining parliament bills for Australian governments.
        
        ## Install via pip
        
        ```
        pip install ausbills
        ```
        
        Current governments that are supported:
        
        - Australian Federal Government
        - Australian Capital Territory Government
        
        ---
        
        ## Australian Federal Government
        
        This module had methods for scraping the [Australian Federal Parliament](https://www.aph.gov.au/Parliamentary_Business/Bills_Legislation/Bills_Lists/Details_page?blsId=legislation%2fbillslst%2fbillslst_c203aa1c-1876-41a8-bc76-1de328bdb726) website, using _beautiful soup_.
        
        The bills are scraped to get data from both the house and the senate:
        
        ```python
        from ausbills.federal_parliment import get_all_bills, Bill
        all_bills = get_all_bills()
        print(all_bills)
        bill_five = all_bills[5]
        ```
        
        `all_bills.data` is a list of all current bills and some basic data in the form of a dict. The rest of the data may be obtained via the **Bill()** object.
        
        ```python
        bill = Bill(bill_id=bill_five["id"])
        print(bill.summary)
        print(bill.sponsor)
        print(bill.bill_text_links)
        print(bill.explanatory_memoranda_links)
        ```
        
        _or_ you can use the url string to create an instance of **Bill()**:
        
        ```python
        bill = Bill(bill_five["url"])
        ```
        
        _or_ the id
        
        ```python
        bill = Bill(bill_five["id"])
        ```
        
        You may also change the date format:
        
        ```python
        bill = Bill(bill_five["id"],"DD/MM/YYYY")
        ```
        
        and you can get the data dump as a dict:
        
        ```python
        bill.data
        ```
        
        ---
        
        ## NSW Government
        
        Using the ```nsw_parliament``` module, you can scrape bills from the [NSW Parliament website](https://www.parliament.nsw.gov.au/bills/pages/all-bills-1997.aspx)
        
        Use ```nsw_all_bills``` to return a list of bill dicts (each dict represents an individual bill).
        ```python
        from nsw_parliament import nsw_all_bills
        
        print(nsw_all_bills)
        print('The first bill returned: ' + nsw_all_bills[0])
        ```
        
        You can return more data on an individual bill using the **nsw_Bill** object:
        
        ```python
        from nsw_parliament import nsw_all_bills, nsw_Bill
        
        all_the_bills_mate = nsw_all_bills
        print(nsw_Bill(all_the_bills_mate).status)
        ```
        
        ---
        
        ## ACT Legislative Assembly
        
        This module allows you to scrape bill data from the [Australian Capital Territory Legislative Assembly](https://www.parliament.act.gov.au/parliamentary-business/in-the-chamber/bills/summary_of_bills) website using _beautiful soup_.
        
        Similarly to the Federal Parliament and WA modules, you can scrape all the bills like this:
        
        ```python
        from act_legislative_assembly import act_all_bills as all_bills
        
        print(all_bills)
        print('The 5th Bill is ' + all_bills[4])
        ```
        
        You can interact with individual bills with the **act_Bill()** object:
        ```python
        all_the_bills = all_bills
        some_bill = act_Bill(all_the_bills[5])
        print(some_bill.title)
        ```
        
        ---
        
        ## 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 origin 0.1.0
        ```
        
        
        
        ### Todo
        
        - Write better usage docs
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
