Metadata-Version: 2.1
Name: ParlPy
Version: 0.1.0
Summary: Scraper and utilities for UK Parliamentary bills
Home-page: https://github.com/Litharge/ParlPy
Author: Robert Chambers
Author-email: 1robertchambers@gmail.com
License: UNKNOWN
Description: # ParlPy
        
        Package to scrape and process UK Parliamentary bills, votes and MP contact information.
        
        Written as part of University of Bath Integrated Project module. 
        
        ---
        
        # Usage
        
        ## Install
        
            pipenv install ParlPy=0.1.0
        
        ## Example Usage
        
        To fetch bills updated since our scraper was last called (uses pickled variable for persistence between program runs)
        
            from parlpy.bills.bill_list_fetcher import BillsOverview
        
            test_fetcher = BillsOverview()
            test_fetcher.get_changed_bills_in_session(session="All")
            print(test_fetcher.bills_overview_data)
        
        ... script can stop and be rerun later, next time bills_overview_data will contain fewer items, unless 
        reset_datetime_last_scraped() has been called first
        
        To fetch all bills in session and print them:
        
            from parlpy.bills.bill_list_fetcher import BillsOverview
            
            test_fetcher2 = BillsOverview()
            test_fetcher2.update_all_bills_in_session()
            print(test_fetcher2.bills_overview_data)
        
        ---
        
        # Subpackages
        
        ## parlpy.bills 
        parlpy.bills for fetching bill data
        
        
        ### Class: BillsOverview
        
        Constructs an object for collecting basic information on all bills in the current Parliamentary session. Its purpose is
        to
        * get a list of existing bills - so that we know what to scrape
        * get path to further details for each bill - so that we can assemble the url to scrape further info from
        
        
        Public instance variables:
        * DataFrame : bills_overview_data 
          
            DF containing bill titles, their last updated time and the path to further
        details on the bill
          
        Public instance methods:
        * None : get_changed_bills_in_session(session_name="2019-21", fetch_delay=0)
        * None : reset_datetime_last_scraped()
        * None : update_all_bills_in_session(session_name="2019-21", fetch_delay=0)
        
            Method to called to update self.bills_overview_data, fetching pages at maximum rate when fetch_delay=0
        
        ---
        
        # Data Sources
        
        ## BillsOverview()
        
        Fetches data from https://bills.parliament.uk
        
        ---
        
        # Versions
        
        ## 0.0.2
        * gets a DataFrame containing bill titles, their last updated times and page paths (page paths to be used in
          future versions)
        * page request delay configurable
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
