Metadata-Version: 2.4
Name: paramiko-mock
Version: 2.0.0
Summary: Mock for paramiko library
Project-URL: Homepage, https://github.com/ghhwer/paramiko-ssh-mock
Project-URL: Repository, https://github.com/ghhwer/paramiko-ssh-mock.git
Project-URL: Issues, https://github.com/ghhwer/paramiko-ssh-mock/issues
Author-email: Caio Cominato <caiopetrellicominato@gmail.com>
License: MIT License
        Copyright (c) 2018 Caio Cominato
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE.txt
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.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Requires-Dist: paramiko>=3.4.0
Provides-Extra: dev
Requires-Dist: mkdocs-autoapi==0.4.0; extra == 'dev'
Requires-Dist: mkdocs-material==9.6.7; extra == 'dev'
Requires-Dist: mkdocstrings[python]==0.29.0; extra == 'dev'
Requires-Dist: pytest==8.2.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-autoapi==0.4.0; extra == 'docs'
Requires-Dist: mkdocs-material==9.6.7; extra == 'docs'
Requires-Dist: mkdocstrings[python]==0.29.0; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest==8.2.0; extra == 'test'
Description-Content-Type: text/markdown

# Paramiko Mock
![Coverage](coverage.svg)

 [![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/ghhwer)

Paramiko Mock is a Python library for mocking the `paramiko` SSH client for testing purposes. It allows you to define responses for specific SSH commands and hosts, making it easier to test code that interacts with remote servers via SSH.

## Version 2.0.0 🚀

We are excited to announce that Paramiko Mock has reached version 2.0.0! 🎉
For more detailed documentation, please visit our [Read the Docs](https://paramiko-ssh-mock.readthedocs.io/en/latest/) page.

## Installation

### Using UV (Recommended)

```bash
# Install UV first (if you haven't already)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install the package
uv add paramiko-mock

# Or install from source
uv sync
```

### Using pip

```bash
pip install paramiko-mock
```

### Development Installation

```bash
# Clone the repository
git clone https://github.com/ghhwer/paramiko-ssh-mock.git
cd paramiko-ssh-mock

# Install with UV (recommended)
uv sync --dev

# Or with pip
pip install -e .
```

## Usage

Here are some examples of how to use paramiko_mock:

Advanced usage is available [here](https://paramiko-ssh-mock.readthedocs.io/en/latest/usage/) and under the /examples folder.

## Contributing

Contributions are welcome. 
Please work on filing an issue before submitting a pull request, so that we can discuss the changes you would like to make.

[Github](https://github.com/ghhwer/paramiko-ssh-mock)

## License

[MIT](https://choosealicense.com/licenses/mit/)
