Update package

voteflux · Mar 20, 2020 · 01f28a3 · 01f28a3
1 parent 3e92db5
commit 01f28a3
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,12 @@ 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.
 
+
+```
+python setup.py sdist
+```
+
+
 ## 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_.

diff --git a/ausbills.egg-info/PKG-INFO b/ausbills.egg-info/PKG-INFO
@@ -1,38 +1,76 @@
 Metadata-Version: 2.1
 Name: ausbills
-Version: 0.0.1
+Version: 0.0.7
 Summary: Get parliament bills for Australian governments.
 Home-page: https://github.com/KipCrossing/Aus-Bills-Discord-Bot
 Author: Kipling Crossing
 Author-email: kip.crossing@gmail.com
 License: UNKNOWN
-Description: # Aus Bills Discord Bot
+Description: # Aus Bills
 
         This is a package is for obtaining parliament bills for Australian governments.
 
+        ## Install via pip
+
+        ```
+        pip3 install git+https://github.com/KipCrossing/Aus-Bills
+        ```
+
         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.
+
         ## 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_, and send to separate Senate and House of Representatives Discord channels as embeds that can be called throughout Discord server.
+        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 upper(senate) and lower house bills are:
+        The bills are scraped to get data from both the house and the senate:
 
         ```python
-        import ausbills
-        ausbills.get_house_bills()
-        ausbills.get_senate_bills()
+        from ausbills.federal_parliment import all_bills, Bill
+        print(all_bills)
+        bill_five = all_bills.data[5]
         ```
 
-        And can easily be turned into pandas dataframes:
+        `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
-        df_lower = pd.DataFrame(ausbills.get_house_bills())
-        df_upper = pd.DataFrame(ausbills.get_senate_bills())
+        bill = Bill(bill_five)
+        print(bill.summary)
+        print(bill.sponsor)
+        bill.bill_text_links
+        bill.explanatory_memoranda_links
         ```
 
+        _or_ you can use the url string to create an instance of **Bill()**:
+
+        ```python
+        bill = Bill(bill_five["URL"])
+        ```
+
+        and you can get the data dump as a dict:
+
+        ```python
+        bill.data
+        ```
+
+        ### Todo
+
+        - get second reading debate links
+        - get third reading links
+
 Platform: UNKNOWN
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License

diff --git a/ausbills.egg-info/SOURCES.txt b/ausbills.egg-info/SOURCES.txt
@@ -1,6 +1,9 @@
 README.md
 setup.py
 ausbills/__init__.py
+ausbills/federal_parliment.py
+ausbills/test.py
+ausbills/wa_parliment.py
 ausbills.egg-info/PKG-INFO
 ausbills.egg-info/SOURCES.txt
 ausbills.egg-info/dependency_links.txt

diff --git a/dist/ausbills-0.0.7.tar.gz b/dist/ausbills-0.0.7.tar.gz
diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="ausbills",  # Replace with your own username
-    version="0.0.6",
+    version="0.0.7",
     author="Kipling Crossing",
     author_email="kip.crossing@gmail.com",
     description="Get parliament bills for Australian governments.",