Metadata-Version: 2.1
Name: fluffypancakes
Version: 0.0.1
Summary: Detect a Phishing Website using Machine Learning
Home-page: https://github.com/suhasrsharma/FluffyPancakes
Author: Suhas Sharma and Rahul P
Author-email: le.bon.garconn@gmail.com
License: UNKNOWN
Description: # Fluffy Pancakes
        
        Fluffy Pancakes is a library designed to detect phishing websites. It uses Machine Learning to predict the output with an accuracy of 95.2%. 
        
        *Note: Please bear with us for a few seconds to get the output since the library is computationally intensive. We felt bad for making you wait, so we have included a progress bar that you can enable to see the percentage of progress and also the time taken for execution. Also note that the library heavily depends on a stable internet connection to function its best and to obtain the results. So, the quicker your internet connection is, the faster your results will be :).*
        
        
        # Usage
        
        - #### Install the module
            ```sh
             $ pip install fluffypancakes
            ```
        
        - #### Import 
            ```sh
             $ import fluffypancakes
             ```
        
        - #### Call the function and Pass the URL 
            ```sh
             $ print(fluffypancakes.serve('<website URL>', progressBar=True))
             ```
        
        - #### Defaults
             The default value of the progressBar is 'True'. However, the option can be enabled or disabled with *boolean* 'True' or 'False' respectively.
        
        - #### Driver
             You'll need a chromedriver in order to complete execution of the code. You can get the file from [here](https://chromedriver.chromium.org/). Unzip and add the "chromedriver.exe" (Windows) or "chromedriver" (Linux and MacOS) file to the PYTHONPATH environment variable.
        
             Well, that's a lot of work right? We know! So, we have included the current stable version of the chromedriver in the [dependencies](https://github.com/suhasrsharma/FluffyPancakes/tree/master/dependencies) folder of the repo.
        
             The code automatically detects the OS (Windows, Linux Based and MacOS) and picks up the respective chromedriver file.
        
             __You're all set to go.__ Although, if, by any chance, you face an issue, just add to PYTHONPATH, the directory structure to where you downloaded this repository.
        
        
        # Output
        > -1 : Legitimate Website
        
        > 1 : Phishing Website
        
        > Sample output:
        >
        > ![Progress Bar](https://github.com/suhasrsharma/FluffyPancakes/blob/master/images/progressBar_inProgress.PNG)
        >
        > ![Progress Bar Completed](https://github.com/suhasrsharma/FluffyPancakes/blob/master/images/progressBar_complete.PNG)
        
        
        The output is predicted with an accuracy of 95.2%. It is not a definitive classification. 
        
        # Dependencies
        
        - Chrome Driver : You'll need a chromedriver in order to complete execution of the code. You can get the file from [here](https://chromedriver.chromium.org/). Unzip and add the "chromedriver.exe" (Windows) or "chromedriver" (Linux and MacOS) file to the PYTHONPATH environment variable.
        
            Well, we know that's a lot of work, so we have included the current stable version of the chromedriver in the [dependencies](https://github.com/suhasrsharma/FluffyPancakes/tree/master/dependencies) folder of the repo.
        
            The code automatically detects the OS (Windows, Linux Based and MacOS) and picks up the respective chromedriver file.
        
            **You're all set to go.** Although, if, by any chance, you face an issue, just add to PYTHONPATH, the directory structure to where you downloaded this repository.
        
        
        # Development
        
        Want to contribute? Great!
        
        FluffyPancakes uses http requests, bs4, selenium, and of course, Machine Learning, and a lot more libraries. 
        You can find the GitHub repository [here](https://github.com/suhasrsharma/FluffyPancakes).
        
        
        Make sure you use the following command to get the exact versions of pytest and check-manifest:
        
        ```sh
        $ pip install -e .[dev]
        ```
        
        You can find the sample test case [here](https://github.com/suhasrsharma/FluffyPancakes/blob/master/src/sample_test.py).
        
        # Development Status
        ##### Development Status :: 4 - Beta
        ##### Version - 0.0.1
        ##### Operating System :: OS Independent
        
        # License
        ### MIT
        ##### Free software? Of Course!
        
        ---
        
        In collaboration with the [ISFCR Lab](https://research.pes.edu/isfcr/) at [PES University](https://www.pes.edu/), Bangalore, India.
Keywords: web phishing detection machine learning
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
Provides-Extra: dev
