Metadata-Version: 2.1
Name: tox-pdm
Version: 0.2.0
Summary: A plugin for tox that utilizes PDM as the package manager and installer
License: MIT
Keywords: tox,testing
Author-email: Frost Ming <mianghong@gmail.com>
Requires-Python: >=3.6
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: lint
Provides-Extra: test
Project-URL: Homepage, https://github.com/pdm-project/tox-pdm
Project-URL: Repository, https://github.com/pdm-project/tox-pdm
Description-Content-Type: text/markdown
Description: # tox-pdm

        A plugin for tox that utilizes PDM as the package manager and installer.

        [![Github Actions](https://github.com/pdm-project/tox-pdm/workflows/Tests/badge.svg)](https://github.com/pdm-project/tox-pdm/actions)
        [![PyPI](https://img.shields.io/pypi/v/tox-pdm?logo=python&logoColor=%23cccccc)](https://pypi.org/project/tox-pdm)
        [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

        With this plugin, you can migrate your project to PDM while retaining the ability to test against multiple versions.

        ## Installation

        ```console
        $ pip install tox-pdm
        ```

        Or,

        ```console
        $ pdm add -d tox-pdm
        ```

        Or if you installed `tox` via `pipx`, you can inject the plugin by:

        ```console
        $ pipx inject tox tox-pdm
        ```

        ## Example tox.ini

        The following simple example installs `dev` and `test` dependencies into the venv created by Tox and uses pytest to execute the tests, on both Python 3.7 and 3.8.

        ```ini
        [tox]
        envlist = py37,py38

        [testenv]
        sections =  ; Dependency sections in pyproject.toml
            dev
            test
        deps =      ; Additional dependencies, it will be installed into the library path via normal pip method
            flake8
        commands =
            pytest test/
        ```

        A real-world example can be found at this repository's [tox.ini](https://github.com/pdm-project/tox-pdm/blob/main/tox.ini) and
        [GitHub Action workflow](https://github.com/pdm-project/tox-pdm/blob/main/.github/workflows/ci.yml).

        ## Some best practices:

        1. `pdm` executable must be exposed in `PATH`, if it is not the case, give the absolute path to tox by `tox --pdm <path_to_pdm>`.
        2. Make sure you have generated `pdm.lock` before running the test, it will greatly accelerate the testing.
        3. If you don't set `skip_install = true`, the current package will be built and installed into the testing environment together with the `dependencies` from `pyproject.toml`.

