Skip to main content

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

Release files for pyionic 0.0.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyionic 0.0.9
File Size Uploaded
pyionic-0.0.9.tar.gz 8.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyionic 0.0.9
File Interpreter ABI Platform
pyionic-0.0.9-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 19.5 kB

Release files / pyionic-0.0.9.tar.gz

Download URL pyionic-0.0.9.tar.gz
Size 8.5 kB
Tags Source
SHA-256 checksum
How to use checksums
239138568f3996ba3d0ca880e05a79d6572a5c3e7cc24d81b8e58a78678dda55
BLAKE2b-256 checksum
How to use checksums
6aac8250c95236d3710cd39784fa7e570054dd10ec9241fc35dae2e80b422115
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / pyionic-0.0.9-py2.py3-none-any.whl

Download URL pyionic-0.0.9-py2.py3-none-any.whl
Size 11.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
4f885cac220196694eb89bda36c682c4a92ad2fcfd9ea61717c15d5894935084
BLAKE2b-256 checksum
How to use checksums
f0a198dcbea5d2d4eab924c3e3f6e230a71511ff7b289b431f39f7d361ee6e75
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.0.9 This release

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

1 release file

0.0.4

2 release files

0.0.3

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page