.. image:: https://img.shields.io/pypi/v/pythx.svg :target: https://pypi.org/project/pythx/
.. image:: https://travis-ci.org/dmuhs/pythx.svg?branch=master :target: https://travis-ci.org/dmuhs/pythx
.. image:: https://readthedocs.org/projects/pythx/badge/?version=latest :target: https://pythx.readthedocs.io/
.. image:: https://coveralls.io/repos/github/dmuhs/pythx/badge.svg?branch=master :target: https://coveralls.io/github/dmuhs/pythx?branch=master
PythX is a library for the MythX_ smart contract security analysis platform.
.. contents:: Table of Contents
MythX is a security analysis API that allows anyone to create purpose-built security tools for smart contract developers. Tools built on MythX integrate seamlessly into the development environments and continuous integration pipelines used throughout the Ethereum ecosystem.
PythX runs on Python 3.6+ and PyPy3.
To get started, simply run
.. code-block:: console
$ pip3 install pythx
Alternatively, clone the repository and run
.. code-block:: console
$ pip3 install .
Or directly through Python's :code:setuptools:
.. code-block:: console
$ python3 setup.py install
PythX aims to provide an easy-to-use interface to the official MythX_ API. Its goal is to turbocharge tool development and make it easy to deal with even complex use cases.
.. code-block:: python3
from pythx import Client
c = Client(api_key="...")
# submit bytecode, source files, their AST and more!
resp = c.analyze(bytecode="0xfe")
# wait for the analysis to finish
while not c.analysis_ready(resp.uuid):
time.sleep(1)
# have all your security report data at your fingertips
for issue in c.report(resp.uuid):
print(issue.swc_title or "Undefined", "-", issue.description_short)
# Output:
# Assert Violation - A reachable exception has been detected.
Originally, the PythX CLI was a proof of concept to display to interested developers what can be done using the library. The interest in the CLI grew so large that a lot of developers contacted me and asked for support and new features.
This is the PSA that I will no longer maintain the PythX CLI. But wait! There's more!
Because a PoC is not exactly what you would call future-proof and maintainable
software, I have decided to do a complete revamp. It is called mythx-cli and
incorporates all feature requests I have gotten so far. Check it out
here <https://github.com/dmuhs/mythx-cli/>_ and let me know what you think!
Enjoy! :)
.. _MythX: https://mythx.io/
mythx-models dependency to omit stale warningMYTHX_API_URL declarationsmythx-cli and :code:mythx-modelsmythx-models to 1.4.1mythx-models to 1.4.0mythx-cli repositorymythx-models to 1.3.5mythx-models to 1.3.3mythx-models to 1.3.2mythx-models to 1.3.1mythx-models to 1.3.0mythx-models <https://github.com/dmuhs/mythx-models>_ integrationclientToolName response fieldmainSource support to CLIFAQs
A Python library for the MythX platform
We found that pythx demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.