Metadata-Version: 2.1
Name: pywebcapture
Version: 0.0.1
Summary: A package that allows users to capture full-page screenshots of websites using Selenium and Chrome webdriver.
Home-page: https://github.com/wirelessfuture/pywebcapture
Author: Christopher Andrews
Author-email: wirelessfuture2000@gmail.com
License: UNKNOWN
Description: # Pywebcapture
        Allows you to loop through a list of uri's and grab a screenshot that can be saved to disk.
        
        Tested with Python version 3.8.3
        
        ## Installation
        
        1. Install [Python](https://www.python.org/downloads/release/python-383/) version 3.8.3 
        2. Install [Git](https://git-scm.com/)
        3. Install virtualenv ```pip install virtualenv```
        4. Change to desired directory ```cd my/workspace/directory/here```
        5. Clone the repo ```git clone https://github.com/wirelessfuture/pywebcapture.git```
        6. Change to newly cloned folder ```cd pywebcapture```
        7. Create a virtual environment ```virtualenv venv```
        8. Activate virtual environment - Windows: ```.\venv\Scripts\activate``` Linux ```source ./venv/bin/activate```
        9. Install requirements ```pip install -r requirements.txt```
        
        ## Basic Usage
        
        **Import the modules:**
        
        ```python
        from driver import Driver as d
        from loader import CSVLoader
        ```
        
        **Use the CSVLoader to load your csv file containing the urls and optional file names:**
        
        Options:
        * input_filepath - The absolute path to your csv file (str)
        * has_header - Whether your csv has a header row or now (bool)
        * uri_column - The column that contains the uri's, can use either column name (str) or the index position (int)
        * filename_column - The column that contains the desired file names (str), can be set to None, where the driver will use the uri netloc as the filename
        
        ```python
        csv_file = CSVLoader("example.csv", True, 3, None)
        ```
        
        **Call the get_uri_dict() method from the CSVLoader instance, this parses the CSV into a Python dictionary:**
        
        ```python
        uri_dict = csv_file.get_uri_dict()
        ```
        
        **Create instance of the web driver:**
        
        Options:
        * output_path - This is the output path that you want to save screen shots at (str), setting to None will output all files to ./screenshots
        * delay - This is the delay in seconds between each page request, minimum is 2 seconds, please crawl pages respectfully :)
        * uri_dict - The Python dictionary containing your file names and uri's
        
        ```python
        d = d(None, 3, uri_dict)
        ```
        
        **Run the driver, this will loop through all uri's, get the maximum scrollheight and then take a screenshot**
        
        ```python
        d.run()
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
