Metadata-Version: 2.1
Name: riptide-plugin-php-xdebug
Version: 0.8.0b1
Summary: Tool to manage development environments for web applications using containers - PHP Xdebug integration
Home-page: https://github.com/theCapypara/riptide-plugin-php-xdebug/
Author: Marco "theCapypara" Köpcke
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: riptide-lib (<0.9,>=0.8.0b1)
Requires-Dist: riptide-cli (<0.9,>=0.8.0b1)
Requires-Dist: Click (>=7.0)

|Riptide|
=========

.. |Riptide| image:: https://riptide-docs.readthedocs.io/en/latest/_images/logo.png
    :alt: Riptide

.. class:: center

    ======================  ===================  ===================  ===================
    *Main packages:*        lib_                 proxy_               cli_
    *Container-Backends:*   engine_docker_
    *Database Drivers:*     db_mysql_            db_mongo_
    *Plugins:*              php_xdebug_
    *Kubernetes:*           k8s_client_          k8s_controller_
    *Related Projects:*     configcrunch_
    *More:*                 docs_                repo_                docker_images_
    ======================  ===================  ===================  ===================

.. _lib:            https://github.com/theCapypara/riptide-lib
.. _cli:            https://github.com/theCapypara/riptide-cli
.. _proxy:          https://github.com/theCapypara/riptide-proxy
.. _configcrunch:   https://github.com/theCapypara/configcrunch
.. _engine_docker:  https://github.com/theCapypara/riptide-engine-docker
.. _db_mysql:       https://github.com/theCapypara/riptide-db-mysql
.. _db_mongo:       https://github.com/theCapypara/riptide-db-mongo
.. _docs:           https://github.com/theCapypara/riptide-docs
.. _repo:           https://github.com/theCapypara/riptide-repo
.. _docker_images:  https://github.com/theCapypara/riptide-docker-images
.. _php_xdebug:     https://github.com/theCapypara/riptide-plugin-php-xdebug
.. _k8s_client:     https://github.com/theCapypara/riptide-k8s-client
.. _k8s_controller: https://github.com/theCapypara/riptide-k8s-controller

|build| |docs| |pypi-version| |pypi-downloads| |pypi-license| |pypi-pyversions|

.. |build| image:: https://img.shields.io/github/actions/workflow/status/theCapypara/riptide-plugin-php-xdebug/build.yml
    :target: https://github.com/theCapypara/riptide-plugin-php-xdebug/actions
    :alt: Build Status

.. |docs| image:: https://readthedocs.org/projects/riptide-docs/badge/?version=latest
    :target: https://riptide-docs.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. |pypi-version| image:: https://img.shields.io/pypi/v/riptide-plugin-php-xdebug
    :target: https://pypi.org/project/riptide-plugin-php-xdebug/
    :alt: Version

.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/riptide-plugin-php-xdebug
    :target: https://pypi.org/project/riptide-plugin-php-xdebug/
    :alt: Downloads

.. |pypi-license| image:: https://img.shields.io/pypi/l/riptide-plugin-php-xdebug
    :alt: License (MIT)

.. |pypi-pyversions| image:: https://img.shields.io/pypi/pyversions/riptide-plugin-php-xdebug
    :alt: Supported Python versions

Riptide is a set of tools to manage development environments for web applications.
It's using container virtualization tools, such as `Docker <https://www.docker.com/>`_
to run all services needed for a project.

It's goal is to be easy to use by developers.
Riptide abstracts the virtualization in such a way that the environment behaves exactly
as if you were running it natively, without the need to install any other requirements
the project may have.

Plugin: PHP Xdebug
------------------

This plugin allows users to toggle the use of Xdebug for PHP based services or commands.

Usage via CLI:

.. code::

   riptide xdebug [on/off]

Sets the flag ``php-xdebug.enabled``, which can be read from Riptide configuration files to
enable or disable Xdebug.

Documentation
-------------

The complete documentation for Riptide can be found at `Read the Docs <https://riptide-docs.readthedocs.io/en/latest/>`_.
