Skip to main content

Python wrapper for https://www.cyrating.com.

Project description

python-cyrating

A python wrapper for Cyrating https://www.cyrating.com.

Latest PyPI Release License Python Support

Installation

pip install cyrating

Then in your application root directory use the following command to set up your configuration including your Cyrating token which is provided in your user interface:

echo -e "[cyrating]\ntoken: cyratingtoken" > cyrating.ini

Usage example

>>> import cyrating
>>> cr = cyrating.init()

The init method takes into account 2 optional parameters:

  • token: the Cyrating token
  • proxies: the list of proxies to use when making a request. See requests docs for more information

Additional methods listed below are available

Method Description
get_main_company returns main company
get_entities returns list of entities
get_suppliers returns list of suppliers
domains return list of domains for a company
set_tags set tags to a specified domain
get_assets get assets for a company
get_facts get results of best practices controls
get_events get list of active reputation events
get_certificate returns certificate of a specific company

Examples

Returns main company

>>> cr.main_company()
[...]

Returns list of entities

>>> cr.entities()
[...]

Returns list of suppliers

>>> cr.suppliers()
[...]

Returns domains of a company

>>> cr.domains(main_company)
[...]

Tag a domain

>>> cr.set_tags('example.com', ['tag1', 'tag2'])
[...]

Get assets

The method get_assets returns a dictionary of assets with tags and type attributes. Each key of this dictionary represents an asset and is linked to the following attributes:

  • type: type of the asset, may be 'domain', 'host' or 'ip'
  • tags: list of tags linked with the asset
  • domains: list of domains linked with the asset
  • entities: list of entities linked with the asset. Entities are the ones included in the subscription.
>>> cr.get_assets(cr.domains(main_company))
[...]

Get results of best practices controls

The method get_facts returns the results of best practices controls. assets parameter is optional and is needed to provide tags association.

An best practice result includes the following attributes:

  • domain: domain name linked with the asset
  • category: name of the best practice's category
  • entities: list of entities linked with the asset. Entities are the ones included in the subscription.
  • tags: list of tags linked with the asset
  • type: type of the asset, may be 'domain', 'host' or 'ip'
  • name: name of the resource
  • results: raw results of the control
  • grade: unitary score of the control
>>> main_company = cr.main_company()
>>> cr.get_events(main_company, assets=cr.get_assets(main_company))
[...]

Get the list of active reputation events

The method get_events returns a list of active reputation events. assets parameter is optional and is needed to provide tags association.

An active reputation event includes the following attributes:

  • name: name of the asset concerned
  • category: name of the reputation's category
  • domains: list of domains linked with the asset
  • entities: list of entities linked with the asset. Entities are the ones included in the subscription.
  • tags: list of tags linked with the asset
  • type: type of the asset, may be 'domain', 'host' or 'ip'
  • source: a dictionary with the tag and the url of the reputation source
  • occurrences: dates of occurrences of the event
  • score: impact on rating of the company. Please note that Cyrating algorithm streamline this score by resource and reputation's category
>>> main_company = cr.main_company()
>>> cr.get_events(main_company, assets=cr.get_assets(main_company))
[...]

Returns certificate of a specific company

>>> main_company = cr.get_main_company()
>>> cr.get_certificate(main_company)

Save certificate of a specific company to a file

>>> main_company = cr.get_main_company()
>>> cr.get_certificate(main_company, filename='Cyrating - Certificate of {}.pdf'.format(main_company['name']))

Meta

Cyrating – @cyratinghello@cyrating.com

Distributed under the ISCL licence. See LICENSE for more information.

Contributing

  1. Send issues to issues@cyrating.com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for cyrating, version 0.0.12
Filename, size File type Python version Upload date Hashes
Filename, size cyrating-0.0.12-py2.py3-none-any.whl (7.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size cyrating-0.0.12.tar.gz (7.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page