Metadata-Version: 2.1
Name: dragoneye
Version: 0.0.22
Summary: Multi-cloud data scan tool
Home-page: https://github.com/indeni/dragoneye
Author: Indeni
Author-email: engineering@indeni.com
License: UNKNOWN
Description: # dragoneye
        dragoneye is a Python tool that is used to collect data about a cloud environment using the cloud provider's APIs. It is intended to function as component in other tools who have the need to collect data quickly, with high performance, and within API quotas.
        
        dragoneye currently supports AWS (AssumeRole and AccessKey based collection) and Azure (with client secret).
        
        # Setup
        Clone this git repository, navigate to the root directory where `setup.py` is located and run:
        ```
        pip install .
        ```
        (note the period at the end of the command)
        
        We recommend doing this within a virtual environment, like so:
        ```
        python3.9 -m venv ./venv
        . ./venv/bin/activate
        pip install .
        ```
        
        # Usage
        
        ## Programmatic Usage
        Create an instance of one of the CollectRequest classes, such as AwsAccessKeyCollectRequest, AwsAssumeRoleCollectRequest, AzureCollectRequest and call the `collect` function. For example:
        ```
        from dragoneye import AwsScanner, AwsCloudScanSettings, AzureScanner, AzureCloudScanSettings, AwsSessionFactory, AzureAuthorizer
        
        
        aws_settings = AwsCloudScanSettings(
            #commands_path='/Users/dev/python/dragoneye/aws_commands_example.yaml',
            commands_path='/Users/dev/python/dragoneye/test.yaml',
            account_name='default', default_region='us-east-1', regions_filter=['us-east-1']
        )
        
        azure_settings = AzureCloudScanSettings(
            commands_path='/Users/dev/python/dragoneye/azure_commands_example.yaml',
            subscription_id='...',
            account_name='my-account'
        )
        
        ### Aws ###
        # Profile / Auth-chain
        
        session = AwsSessionFactory.get_session(profile_name=None)  # Raises exception if authentication is unsuccessful
        AwsScanner(session, aws_settings).scan()
        # Assume Role
        session = AwsSessionFactory.get_session_using_assume_role(external_id='...',
                                                                  role_arn="...",
                                                                  region='us-east-1')
        aws_scan_output_directory = AwsScanner(session, aws_settings).scan()
        
        ### Azure ###
        token = AzureAuthorizer.get_authorization_token(
            tenant_id='...',
            client_id='...',
            client_secret='...'
        )  # Raises exception if authentication is unsuccessful
        azure_scan_output_directory = AzureScanner(token, azure_settings).scan()
        
        ```
        
        ## CLI usage
        
        ### For collecting data from AWS
        ```
        dragoneye aws [options]
        ```
        
        ### For collecting data from Azure with a client secret
        ```
        dragoneye azure [options]
        ```
        
Keywords: cloud,aws,azure,scan
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
