compatibility-lib 0.1.11
A library to get and store the dependency compatibility status data to BigQuery.
License: Apache-2.0

Compatibility Lib
=================

    A library that calls the compatibility server to get compatibility
    information about Python packages, and provides utilities to store the
    results into BigQuery.

Running the server locally
--------------------------

1. Install Docker_

.. _Docker: https://www.docker.com/community-edition

2. Download the code:

    ::

        git clone git@github.com:GoogleCloudPlatform/cloud-opensource-python.git

3. Build and run the Docker image

    ::

        cd cloud-opensource-python/compatbility_server
        ./run-in-docker.sh

Testing the server out
----------------------

    ::

      curl 'http://0.0.0.0:8888/?package=six&package=Django&python-version=3' | python3 -m json.tool
      {
        "result": "SUCCESS",
        "packages": [
          "six",
          "Django"
        ],
        "description": null,
        "requirements": "absl-py==0.2.2\napparmor==2.11.1\nasn1crypto==0.24.0\nastor==0.6.2\natomicwrites==1.1.5\nattrs==18.1.0\nbleach==1.5.0\nblinker==1.3\nBrlapi==0.6.6\ncachetools==2.1.0\ncertifi==2018.4.16\nchardet==3.0.4\ncheckbox-ng==0.23\ncheckbox-support==0.22\ncolorlog==2.10.0\ncryptography==2.1.4\ncupshelpers==1.0\ndecorator==4.3.0\ndefer==1.0.6\nDjango==2.0.6\nfeedparser==5.2.1\ngast==0.2.0\nglinux-rebootd==0.1\ngoobuntu-config-tools==0.1\ngoogle-api-core==1.2.0\ngoogle-auth==1.5.0\ngoogleapis-common-protos==1.5.3\ngpg==1.10.0\ngrpcio==1.12.1\nguacamole==0.9.2\nhtml5lib==0.9999999\nhttplib2==0.9.2\nidna==2.6\nimportlab==0.1.1\nIPy==0.83\nJinja2==2.9.6\nkeyring==10.5.1\nkeyrings.alt==2.2\nLibAppArmor==2.11.1\nlouis==3.3.0\nlxml==4.0.0\nMako==1.0.7\nMarkdown==2.6.11\nMarkupSafe==1.0\nmore-itertools==4.2.0\nnetworkx==2.1\nnox-automation==0.19.0\nnumpy==1.14.5\noauthlib==2.0.4\nobno==29\nolefile==0.44\nonboard==1.4.1\nopencensus==0.1.5\npadme==1.1.1\npexpect==4.2.1\nPillow==4.3.0\nplainbox==0.25\npluggy==0.6.0\nprotobuf==3.5.2.post1\npsutil==5.4.2\npy==1.5.3\npyasn1==0.4.3\npyasn1-modules==0.2.1\npycairo==1.15.4\npycrypto==2.6.1\npycups==1.9.73\npycurl==7.43.0\npygobject==3.26.1\npyinotify==0.9.6\nPyJWT==1.5.3\npyOpenSSL==17.5.0\npyparsing==2.1.10\npysmbc==1.0.15.6\npytest==3.6.1\npython-apt==1.4.0b3\npython-debian==0.1.31\npython-xapp==1.0.0\npython-xlib==0.20\npytype==2018.5.22.1\npytz==2018.4\npyxdg==0.25\nPyYAML==3.12\nreportlab==3.3.0\nrequests==2.18.4\nretrying==1.3.3\nrsa==3.4.2\nSecretStorage==2.3.1\nsetproctitle==1.1.10\nsix==1.11.0\ntensorboard==1.8.0\ntensorflow==1.8.0\ntermcolor==1.1.0\nufw==0.35\nunattended-upgrades==0.1\nurllib3==1.22\nvirtualenv==16.0.0\nWerkzeug==0.14.1\nXlsxWriter==0.9.6\nyoutube-dl==2017.11.6\n"
        }

Get Compatibility Data using the library
----------------------------------------

The library is sending requests to the compatibility server running GKE.

    ::

      from compatibility_lib import compatibility_checker

      checker = compatibility_checker.CompatibilityChecker()

      # Get self compatibility data
      checker.get_self_compatibility(python_version='2')

      # Get pairwise compatibility data
      checker.get_pairwise_compatibility(python_version='2')

      # Get the data and store to BigQuery
      from compatibility_lib import get_compatibility_data

      get_compatibility_data.write_to_status_table()

Disclaimer
----------

This is not an official Google product.