README.rst

Badge Server

Displaying the compatibility status for your package as a Github Badge.

Types of badges

1. Self Compatibility
2. Compatibility with Google OSS Python packages
3. Dependency version status

Usage

What to Check

• Latest released version on PyPI

package=[name_on_pypi]

• Github head version

package=git%2Bgit://github.com/[your_repo_name].git%23subdirectory=[subdirectory_containing_setup_py_file]

How to Check

• One badge

Add this line to your README file on Github:

.. |package_details_example| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=compatibility_lib
   :target: https://python-compatibility-tools.appspot.com/one_badge_target?package=compatibility_lib

And the badge for package details will show up like below:

• Multiple badges

Adding the link of the badge image and badge target to your README file on Github:

.. csv-table::
   :header: "CHECK_TYPE", "RESULT"
   :widths: 20, 30

   "Self Compatibility", |self_compatibility|
   "Google Compatibility", |google_compatibility|
   "Dependency Version Status", |dependency_version_status|

.. |self_compatibility| image:: https://python-compatibility-tools.appspot.com/self_compatibility_badge_image?package=compatibility_lib
   :target: https://python-compatibility-tools.appspot.com/self_compatibility_badge_target?package=compatibility_lib
.. |google_compatibility| image:: https://python-compatibility-tools.appspot.com/google_compatibility_badge_image?package=compatibility_lib
   :target: https://python-compatibility-tools.appspot.com/google_compatibility_badge_target?package=compatibility_lib
.. |dependency_version_status| image:: https://python-compatibility-tools.appspot.com/self_dependency_badge_image?package=compatibility_lib
   :target: https://python-compatibility-tools.appspot.com/self_dependency_badge_target?package=compatibility_lib

And the badges will show up like below:

For maintainers

Steps for building the docker image and deploying to GKE:

• Update the dependency version in requirements.txt if there are any.
• Deploy!

gcloud app deploy