Metadata-Version: 2.1
Name: ezrest
Version: 0.1.0
Summary: Modular Python framework for implementing REST API clients
Author: Jacek Lewański
License: MIT License
        
        Copyright (c) 2024 Jacek Lewański
        
        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.
Project-URL: Homepage, https://github.com/nullJaX/ezrest
Project-URL: Documentation, https://nullJaX.github.io/ezrest
Project-URL: Issues, https://github.com/nullJaX/ezrest/issues
Project-URL: Release notes, https://github.com/nullJaX/ezrest/releases
Keywords: rest,api,client,framework,ezrest
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Classifier: Typing :: Typed
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: build ; extra == 'dev'
Requires-Dist: httpx ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-asyncio ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: ruff ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'

# ezrest

*Modular Python framework for implementing REST API clients*

## Overview

`ezrest` is a modular Python library crafted to streamline and standardize REST API client development. This package offers design patterns without concrete implementations, empowering developers to customize behaviors for distinct APIs. Its primary aim is not to offer a comprehensive solution but to serve as a blueprint for creating straightforward and maintainable API clients.

## Features

- **Modular design - tailored usage:** `ezrest` is structured into independent modules, allowing developers to selectively utilize only the required components. This approach ensures streamlined code implementation, eliminating the need for unnecessary features.

- **Best practices templates:** `ezrest` aims to serve as a guiding template for REST API client development, mitigating the risk of adopting poor practices. Developers can adhere to designated design patterns and recommendations to craft API clients that are both maintainable and performant.

## Installation

**Requirements:** Python 3.8+

```bash
pip install ezrest
# Or by providing specific version:
pip install ezrest==0.1.0
```

## Usage <!-- {docsify-ignore} -->

Please refer to the [documentation pages](https://nullJaX.github.io/ezrest/#/modules) on how to use this module.

## Contributing

All forms of contribution are welcome. If you have ideas for new features, improvements or bug fixes, please [open an issue](https://github.com/nullJaX/ezrest/issues) or [submit a pull request on GitHub](https://github.com/nullJaX/ezrest/pulls).

## License <!-- {docsify-ignore} -->

This project is licensed under the [MIT License](https://github.com/nullJaX/ezrest/blob/master/LICENSE).
