Metadata-Version: 2.1
Name: pyraider
Version: 0.4.6
Summary: Using PyRaider You can scan installed dependencies known security vulnerabilities. It uses publicly known exploits, vulnerabilities database.
Home-page: https://github.com/raidersource/pyraider
Author: Tilak Thimmappa
Author-email: tilaknayarmelpal@gmail.com
License: UNKNOWN
Description: # PyRaider
        
        > Using PyRaider You can scan installed dependencies known security vulnerabilities. It uses publicly known exploits, vulnerabilities database. [Documentation](https://pyraider.raidersource.com)
        
                                            
        ## Usage
        
        [Documentation](https://pyraider.raidersource.com/#/)
        
        ### Install `pyraider` using pip
        
        ```commandline
        pip install pyraider
        ```
        
        ### Once a `pyraider` you can run help command. It will show you the list commands and examples.
        
        ```commandline
        pyraider -h
        ```
        
        ### You can use `pyraider -v` to check the version.
        
        ```commandline
        pyraider -v
        ```
        
        ##  Scan Vulnerabilities against the dependencies
        > Using PyRaider you can scan the vulnerable packages.
        
        ### To run basic scan you can use `pyraider go` command. It will automatically detects the installed packages and scans against it and shows the report.
        
        ```commandline
        pyraider go
        ```
        
        **Note:** If you are running this command first time. The resource database will be downloaded. It may take sometime to download. This will be downloading only once. It won't  downloading everytime.
        
        ### If you want to scan you packages against `requirements.txt` or `Pipfile.lock` file.
        
        ```commandline
        pyraider check -f /Users/raider/project/requirements.txt
        ```
        
        ```commandline
        pyraider check -f /Users/raider/project/Pipfile.lock
        ```
        
        ### If you want to scan the packages in the same directory.
        
        ```commandline
        pyraider check -f .
        ```
        
        **Note:** If you are running this command first time. The resource database will be downloaded. It may take sometime to download. This will be downloading only once. It won't  downloading everytime.
        
        ## Reports
        > PyRaider currently supports `JSON` and `CSV` formats.
        
        ### To Export as a `JSON` file.
        
        ```commandline
        pyraider check -f /Users/raider/project/requirments.txt -e json result.json
        ```
        
        ```commandline
        pyraider check -f /Users/raider/project/Pipfile.lock -e json result.json
        ```
        
        ### To Export as a `CSV` file.
        
        ```commandline
        pyraider check -f /Users/raider/project/requirments.txt -e csv result.csv
        ```
        
        ```commandline
        pyraider check -f /Users/raider/project/Pipfile.lock -e csv result.csv
        ```
        
        
        ## Out of Date Pacakges
        > Using PyRaider you can check the latest packages. Aginst installed packages.
        
        ```commandline
        pyraider validate -f /Users/raider/project/requirments.txt
        ```
        
        ```commandline
        pyraider validate -f /Users/raider/project/Pipfile.lock
        ```
        
        * It will check out of dated packages on the actiavted virtual environment.
        ```commandline
        pyraider validate 
        ```
        
        
        ## Auto Fix
        > PyRaider also supports `auto fix` feature. Using this you can fix the vulnerable packages.
        
        **Note:** To updating the packages might affect your application.
        
        ### Fix
        > You can fix packages vulnerabilities individually. Once it is installed it will automatically update the `requirments.txt` or `Pipfile.lock` file.
        
        ```
        pyraider fix
        ```
        
        ### Autofix
        > You can also fix packages vulnerabilities at one shot. Once it is installed it will automatically update the `requirments.txt` or `Pipfile.lock` file.
        
        ```
        pyraider autofix
        ```
        
        ### Update latest database
        > Now you can update the resource database with latest updated vulnerabilities
        
        ```
        pyraider updatedb
        ```
        
        ## Docker container
        > You can also run `pyraider` has a docker container.
        
        ### Build docker container image
        
        ```
        docker build -t pyraider .
        ```
        
        ### Contribute
        * We welcome contributions to this project in the form of:
            * Feature Requests, Suggestions
            * Bugs
            * Help with writing tests
            * Add-on features, plugins, etc
            * Documentation
        
        ### Contact us:
        * Email : tilaknayarmelpal@gmail.com
        * Twitter : https://twitter.com/ti1akt
Keywords: SCA,pyraider,Source Composition Analysis,vulnerability scanner
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
