Metadata-Version: 2.1
Name: mythx-models
Version: 1.3.2
Summary: Python domain model classes for the MythX platform
Home-page: https://github.com/dmuhs/mythx-models
Author: Dominik Muhs
Author-email: dominik.muhs@consensys.net
License: MIT license
Keywords: mythx
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: jsonschema (==3.0.2)
Requires-Dist: python-dateutil (==2.8.0)
Requires-Dist: inflection (==0.3.1)

=======================
The MythX Domain Models
=======================


.. image:: https://img.shields.io/pypi/v/mythx-models.svg
        :target: https://pypi.org/project/mythx-models/

.. image:: https://travis-ci.org/dmuhs/mythx-models.svg?branch=master
        :target: https://travis-ci.org/dmuhs/mythx-models

.. image:: https://readthedocs.org/projects/mythx-models/badge/?version=latest
        :target: https://mythx-models.readthedocs.io/en/latest/?badge=latest

.. image:: https://pyup.io/repos/github/dmuhs/mythx-models/shield.svg
        :target: https://pyup.io/repos/github/dmuhs/mythx-models/

.. image:: https://coveralls.io/repos/github/dmuhs/mythx-models/badge.svg?branch=master
        :target: https://coveralls.io/github/dmuhs/mythx-models?branch=master


This repository contains the domain models for the MythX_ smart contract security analysis platform.

.. contents:: Table of Contents


What is MythX?
--------------
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.


Installation
------------
The MythX domain models runs on Python 3.5+.

To get started, simply run

.. code-block:: console

    $ pip3 install mythx-models

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


.. _MythX: https://mythx.io/


=======
History
=======

1.2.0
-----

- Added models for source map representation (including source map decompression)


1.1.0
-----

- Removed the minimum size limit for a detected issue report list
- Added an :code:`as_list` option to the detected issue response model to support non-object input


1.0.0
-----

- Added all models originally in PythX
- Extended models with :code:`BaseModel` class
- Make issue reports and various submodels JSON serializable
- Added documentation to readthedocs.io
- Added CI with Travis
- Added coverage metrics with codecov
- Added packaging pipeline to PyPI


