[client/examples] Introduce the black formatter (OpenCTI-Platform#53)

Author: Samuel Hassine

.circleci/config.yml

@@ -10,6 +10,9 @@ jobs:
       - run:
           name: install dependencies
           command: pip3 install -r requirements.txt --user
+      - run:
+          name: install dependencies
+          command: black --check .
       - run:
           name: build
           command: python3 setup.py sdist

examples/add_external_reference_to_report.py

@@ -4,37 +4,35 @@
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = 'https://demo.opencti.io'
-api_token = 'bb4aca90-b98c-49ee-9582-7eac92b61b82'
+api_url = "https://demo.opencti.io"
+api_token = "bb4aca90-b98c-49ee-9582-7eac92b61b82"
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
 
 # Define the date
-date = parse('2019-12-01').strftime('%Y-%m-%dT%H:%M:%SZ')
+date = parse("2019-12-01").strftime("%Y-%m-%dT%H:%M:%SZ")
 
 # Create the report
 report = opencti_api_client.report.create(
-    name='My test report',
-    description='A new threat report.',
+    name="My test report",
+    description="A new threat report.",
     published=date,
-    report_class='Threat Report'
+    report_class="Threat Report",
 )
 
 # Create the external reference
 external_reference = opencti_api_client.external_reference.create(
-    source_name='Wikipedia',
-    url='https://en.wikipedia.org/wiki/Fancy_Bear'
+    source_name="Wikipedia", url="https://en.wikipedia.org/wiki/Fancy_Bear"
 )
 
 # Add the external reference to the report
 opencti_api_client.stix_entity.add_external_reference(
-    id=report['id'],
-    external_reference_id=external_reference['id']
+    id=report["id"], external_reference_id=external_reference["id"]
 )
 
 # Get the report
-report = opencti_api_client.report.read(id=report['id'])
+report = opencti_api_client.report.read(id=report["id"])
 
 # Print
-print(report)
+print(report)

examples/add_organization_to_sector.py

@@ -5,31 +5,31 @@
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = 'https://demo.opencti.io'
-api_token = 'bb4aca90-b98c-49ee-9582-7eac92b61b82'
+api_url = "https://demo.opencti.io"
+api_token = "bb4aca90-b98c-49ee-9582-7eac92b61b82"
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
 
 # Get the sector
-sector = opencti_api_client.identity.read(filters=[{'key': 'name', 'values': ['Banking institutions']}])
+sector = opencti_api_client.identity.read(
+    filters=[{"key": "name", "values": ["Banking institutions"]}]
+)
 
 # Create the organization
 organization = opencti_api_client.identity.create(
-    type='Organization',
-    name='BNP Paribas',
-    description='A french bank.'
+    type="Organization", name="BNP Paribas", description="A french bank."
 )
 
 # Create the relation
 relation = opencti_api_client.stix_relation.create(
-    fromType='Organization',
-    fromId=organization['id'],
-    toType='Sector',
-    toId=sector['id'],
-    relationship_type='gathering',
-    description='BNP Paribas is part of the sector Banking institutions.',
-    ignore_dates=True
+    fromType="Organization",
+    fromId=organization["id"],
+    toType="Sector",
+    toId=sector["id"],
+    relationship_type="gathering",
+    description="BNP Paribas is part of the sector Banking institutions.",
+    ignore_dates=True,
 )
 
 # Print

examples/add_tag_to_malware.py

@@ -4,31 +4,25 @@
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = 'https://demo.opencti.io'
-api_token = 'bb4aca90-b98c-49ee-9582-7eac92b61b82'
+api_url = "https://demo.opencti.io"
+api_token = "bb4aca90-b98c-49ee-9582-7eac92b61b82"
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
 
 # Create the malware
 malware = opencti_api_client.malware.create(
-    name='My new malware',
-    description='A new evil tool.'
+    name="My new malware", description="A new evil tool."
 )
 
 # Create the tag (if not exists)
 tag = opencti_api_client.tag.create(
-    tag_type='Malware-Type',
-    value='Ranswomware',
-    color='#ffa500',
+    tag_type="Malware-Type", value="Ranswomware", color="#ffa500",
 )
 
 # Add the tag
-opencti_api_client.stix_entity.add_tag(
-    id=malware['id'],
-    tag_id=tag['id']
-)
+opencti_api_client.stix_entity.add_tag(id=malware["id"], tag_id=tag["id"])
 
 # Print
-malware = opencti_api_client.malware.read(id=malware['id'])
-print(malware)
+malware = opencti_api_client.malware.read(id=malware["id"])
+print(malware)

examples/add_tool_usage_to_intrusion-set.py

@@ -6,9 +6,8 @@
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = 'https://demo.opencti.io'
-api_token = 'bb4aca90-b98c-49ee-9582-7eac92b61b82'
+api_url = "https://demo.opencti.io"
+api_token = "bb4aca90-b98c-49ee-9582-7eac92b61b82"
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
-

examples/create_campaign_attributed-to_intrusion_set.py

@@ -4,46 +4,46 @@
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = 'https://demo.opencti.io'
-api_token = 'bb4aca90-b98c-49ee-9582-7eac92b61b82'
+api_url = "https://demo.opencti.io"
+api_token = "bb4aca90-b98c-49ee-9582-7eac92b61b82"
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
 
 # Define the date
-date = parse('2019-12-01').strftime('%Y-%m-%dT%H:%M:%SZ')
+date = parse("2019-12-01").strftime("%Y-%m-%dT%H:%M:%SZ")
 
 # Create the Intrusion Set
 intrusion_set = opencti_api_client.intrusion_set.create(
-    name='My new Intrusion Set',
-    description='Evil Cluster',
+    name="My new Intrusion Set",
+    description="Evil Cluster",
     first_seen=date,
     last_seen=date,
-    update=True
+    update=True,
 )
 print(intrusion_set)
 
 # Create the Campaign
 campaign = opencti_api_client.campaign.create(
-    name='My new Campaign',
-    description='Large SpearPhishing and intrusions followed by ransomware',
-    objective='Financial gain',
+    name="My new Campaign",
+    description="Large SpearPhishing and intrusions followed by ransomware",
+    objective="Financial gain",
     first_seen=date,
     last_seen=date,
-    update=True
+    update=True,
 )
 print(campaign)
 
 # Attribute the Campaign to the Intrusion Set
 relation = opencti_api_client.stix_relation.create(
-    fromType='Campaign',
-    fromId=campaign['id'],
-    toType='Intrusion-Set',
-    toId=intrusion_set['id'],
-    relationship_type='attributed-to',
+    fromType="Campaign",
+    fromId=campaign["id"],
+    toType="Intrusion-Set",
+    toId=intrusion_set["id"],
+    relationship_type="attributed-to",
     first_seen=date,
     last_seen=date,
-    description='My new campaign is attributed to my new Intrusion Set, the evil cluster.'
+    description="My new campaign is attributed to my new Intrusion Set, the evil cluster.",
 )
 
 # Print

examples/create_hashes_and_link_together.py

@@ -3,57 +3,57 @@
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = 'https://demo.opencti.io'
-api_token = 'bb4aca90-b98c-49ee-9582-7eac92b61b82'
+api_url = "https://demo.opencti.io"
+api_token = "bb4aca90-b98c-49ee-9582-7eac92b61b82"
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
 
 # Create observables
 hash_md5 = opencti_api_client.stix_observable.create(
-    type='File-MD5',
-    observable_value='16b3f663d0f0371a4706642c6ac04e42',
-    description='Hash linked to Emotet',
-    update=True
+    type="File-MD5",
+    observable_value="16b3f663d0f0371a4706642c6ac04e42",
+    description="Hash linked to Emotet",
+    update=True,
 )
 print(hash_md5)
 hash_sha1 = opencti_api_client.stix_observable.create(
-    type='File-SHA1',
-    observable_value='3a1f908941311fc357051b5c35fd2a4e0c834e37',
-    description='Hash linked to Emotet',
-    update=True
+    type="File-SHA1",
+    observable_value="3a1f908941311fc357051b5c35fd2a4e0c834e37",
+    description="Hash linked to Emotet",
+    update=True,
 )
 print(hash_sha1)
 hash_sha256 = opencti_api_client.stix_observable.create(
-    type='File-SHA256',
-    observable_value='bcc70a49fab005b4cdbe0cbd87863ec622c6b2c656987d201adbb0e05ec03e56',
-    description='Hash linked to Emotet',
-    update=True
+    type="File-SHA256",
+    observable_value="bcc70a49fab005b4cdbe0cbd87863ec622c6b2c656987d201adbb0e05ec03e56",
+    description="Hash linked to Emotet",
+    update=True,
 )
 print(hash_sha256)
 
 # Create relations
 opencti_api_client.stix_observable_relation.create(
-    relationship_type='corresponds',
-    fromType='File-MD5',
-    fromId=hash_md5['id'],
-    toType='File-SHA1',
-    toId=hash_sha1['id'],
-    ignore_dates=True
+    relationship_type="corresponds",
+    fromType="File-MD5",
+    fromId=hash_md5["id"],
+    toType="File-SHA1",
+    toId=hash_sha1["id"],
+    ignore_dates=True,
 )
 opencti_api_client.stix_observable_relation.create(
-    relationship_type='corresponds',
-    fromType='File-MD5',
-    fromId=hash_md5['id'],
-    toType='File-SHA256',
-    toId=hash_sha256['id'],
-    ignore_dates=True
+    relationship_type="corresponds",
+    fromType="File-MD5",
+    fromId=hash_md5["id"],
+    toType="File-SHA256",
+    toId=hash_sha256["id"],
+    ignore_dates=True,
 )
 opencti_api_client.stix_observable_relation.create(
-    relationship_type='corresponds',
-    fromType='File-SHA1',
-    fromId=hash_sha1['id'],
-    toType='File-SHA256',
-    toId=hash_sha256['id'],
-    ignore_dates=True
+    relationship_type="corresponds",
+    fromType="File-SHA1",
+    fromId=hash_sha1["id"],
+    toType="File-SHA256",
+    toId=hash_sha256["id"],
+    ignore_dates=True,
 )