About

1
2
3
4
 ___                   _   ___ ___    ___ _ _         _   
| _ ) __ _ ___ ___    /_\ | _ \_ _|  / __| (_)___ _ _| |_ 
| _ \/ _` (_-</ -_)  / _ \|  _/| |  | (__| | / -_) ' \  _|
|___/\__,_/__/\___| /_/ \_\_| |___|  \___|_|_\___|_||_\__|
Platform: Linux/Mac/Windows Python 3.8.x Build Coverage 68%

Base module for REST API clients.

Installation

1
pip3 install base-api-client

Basic Usage

This modules’ primary use-case is inheritance from other REST API clients.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from base_api_client import BaseApiClient
from typing import Optional, Union

class SomeApiClient(BaseApiClient):
    def __init__(self, cfg: Union[str, dict]):
        BaseApiClient.__init__(self, cfg=cfg)

    def __aenter__(self):
        return self

    def __aexit__(self, exc_type, exc_val, exc_tb):
        await BaseApiClient.__aexit__(self, exc_type, exc_val, exc_tb)

Coverage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
----------- coverage: platform linux, python 3.8.1-final-0 -----------
Name                                 Stmts   Miss  Cover
--------------------------------------------------------
base_api_client/__init__.py              3      0   100%
base_api_client/client.py              244     71    71%
base_api_client/models/__init__.py       3      0   100%
base_api_client/models/record.py        35     18    49%
base_api_client/models/results.py       25     11    56%
base_api_client/utils.py                23      7    70%
--------------------------------------------------------
TOTAL                                  333    107    68%

Documentation

GitHub Pages - Work in Process

License

Copyright © 2019-2020 Jerod Gawne https://github.com/jerodg/

This program is free software: you can redistribute it and/or modify it under the terms of the Server Side Public License (SSPL) as published by MongoDB, Inc., either version 1 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the SSPL for more details.

You should have received a copy of the SSPL along with this program. If not, see https://www.mongodb.com/licensing/server-side-public-license.