Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Python package for the Ion Channel API

Project description

PyIonic

Documentation Status https://travis-ci.org/ion-channel/pyionic.svg?branch=master https://img.shields.io/pypi/v/pyionic.svg

PyIonic is a Python library to interact with Ion Channel’s API. With PyIonic it should be very easy for a user to interact with Ion Channel and get their data.

Documentation

Read up on the docs here: http://pyionic.readthedocs.io/

Quick Start

Install PyIonic:

pip install pyionic

Set the IONCHANNEL_SECRET_KEY:

export IONCHANNEL_SECRET_KEY=####IONCHANNEL_SECRET_KEY####

Examples

Sample code to report the name, id, and source of all of the projects in a team.

from pyionic import core
users = core.Users()
team_id = list(users.get_self()['data']['teams'].keys())[0]
projects = core.Projects()
print('--------------------------------')
for project in projects.get_projects(team_id)['data']:
    print('Name: %s' % project['name'])
    print('ID: %s' % project['id'])
    print('Source: %s' % project['source'])
    print('--------------------------------')

Sample code to get an analysis for all projects in a team. Reports the name, id, source and if the project passed the last analysis.

from pyionic import core
users = core.Users()
team_id = list(users.get_self()['data']['teams'].keys())[0]
projects = core.Projects()
analysis = core.Analysis()
print('--------------------------------')
for project in projects.get_projects(team_id)['data']:
    print('Name: %s' % project['name'])
    print('ID: %s' % project['id'])
    print('Source: %s' % project['source'])
    analysis_id = analysis.get_analysis_summery(
        team_id=team_id,
        project_id=project['id']
    )['data']['id']
    if analysis.get_analysis(
        team_id=team_id,
        project_id=project['id'],
        analysis_id=analysis_id
    )['data']['status'] == 'finished':
        print('Scan is good!')
    print('--------------------------------')

Sample code to count all of the vulnerabilities for Python 3.4

from pyionic import core
vuln = core.Vulnerability()
vulnerabilities = vuln.get_vulnerabilities('python', '3.4')
print('%s total vulnerabilities found.' % vulnerabilities['meta']['total_count'])

Tests

To setup tests you must first export a valid token for the pyionic test team:

export IONCHANNEL_SECRET_KEY=####IONCHANNEL_SECRET_KEY####

Then run:

pipenv run python setup.py test

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 pyionic, version 0.0.9
Filename, size File type Python version Upload date Hashes
Filename, size pyionic-0.0.9-py2.py3-none-any.whl (11.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size pyionic-0.0.9.tar.gz (8.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page