Metadata-Version: 2.1
Name: scarlet-shark-client
Version: 1.0.5
Summary: Scarlet Shark REST API Python client
Home-page: https://github.com/PiRogueToolSuite/scarlet-shark-python
Author: U+039b
Author-email: esther@pts-project.org
License: UNKNOWN
Description: # scarlet-shark-python
        Scarlet Shark REST API Python client.
        
        ## Installation
        ```
        pip install scarlet-shark-client
        ```
        
        ## Usage example
        
        ```python
        from scarlet_shark_client.client import ClientFactory
        
        client = ClientFactory.get_client('<your API key>', api_version='v0.4', print_json=True)
        result = client.search_domain(domain='scarletshark.com')
        ```
        prints
        ```json
        {
          "age": 4043,
          "associated_urls": [],
          "classification": "security",
          "disclosure_email": "unknown",
          "domain": "scarletshark.com",
          "domain_description": "",
          "ip": "40.[redacted]",
          "reference_url": "",
          "registered": "2012-04-02",
          "service": {
            "service_email": "",
            "service_id": 0,
            "service_name": "unknown",
            "service_trust": "unknown",
            "service_type": "unknown",
            "service_url": ""
          },
          "tags": [
            "security"
          ],
          "threat_actor_aliases": [],
          "threat_actor_id": 0,
          "threat_classification": "safe",
          "threat_explanation": "The domain is considered to be safe and it hosts no known malicious content.",
          "tracking_domain": false
        }
        ```
        
        ## Supported actions
        ### API version 0.4
        * search_dns
        * search_domain
        * search_email
        * search_hash
        * search_ip
        * search_network
        * search_threat_actors
        * search_threat_tools
        * search_url
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Natural Language :: English
Classifier: Topic :: Security
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
