Python common code for Directory API clients.
Project description
# directory-client-core
[![code-climate-image]][code-climate]
[![circle-ci-image]][circle-ci]
[![codecov-image]][codecov]
[![gemnasium-image]][gemnasium]
**Directory Client Core.**
Common code for the Directory API clients.
---
## Requirements
## Installation
```shell
pip install -e git+https://git@github.com/uktrade/directory-client-core.git@0.0.1#egg=directory-client-core
```
## Usage
```python
from directory_client_core.client import ClientBase
class MyAPIClient(ClientBase):
def get_something(self):
return self.get(...)
def create_sometime(self):
return self.post(...)
```
## Development
$ git clone https://github.com/uktrade/directory-client-core
$ cd directory-client-core
## Publish to PyPI
The package should be published to PyPI on merge to master. If you need to do it locally then get the credentials from rattic and add the environment variables to your host machine:
| Setting |
| --------------------------- |
| DIRECTORY_PYPI_USERNAME |
| DIRECTORY_PYPI_PASSWORD |
Then run the following command:
make publish
[code-climate-image]: https://codeclimate.com/github/uktrade/directory-client-core/badges/issue_count.svg
[code-climate]: https://codeclimate.com/github/uktrade/directory-client-core
[circle-ci-image]: https://circleci.com/gh/uktrade/directory-client-core/tree/master.svg?style=svg
[circle-ci]: https://circleci.com/gh/uktrade/directory-client-core/tree/master
[codecov-image]: https://codecov.io/gh/uktrade/directory-client-core/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/uktrade/directory-client-core
[gemnasium-image]: https://gemnasium.com/badges/github.com/uktrade/directory-client-core.svg
[gemnasium]: https://gemnasium.com/github.com/uktrade/directory-client-core
[![code-climate-image]][code-climate]
[![circle-ci-image]][circle-ci]
[![codecov-image]][codecov]
[![gemnasium-image]][gemnasium]
**Directory Client Core.**
Common code for the Directory API clients.
---
## Requirements
## Installation
```shell
pip install -e git+https://git@github.com/uktrade/directory-client-core.git@0.0.1#egg=directory-client-core
```
## Usage
```python
from directory_client_core.client import ClientBase
class MyAPIClient(ClientBase):
def get_something(self):
return self.get(...)
def create_sometime(self):
return self.post(...)
```
## Development
$ git clone https://github.com/uktrade/directory-client-core
$ cd directory-client-core
## Publish to PyPI
The package should be published to PyPI on merge to master. If you need to do it locally then get the credentials from rattic and add the environment variables to your host machine:
| Setting |
| --------------------------- |
| DIRECTORY_PYPI_USERNAME |
| DIRECTORY_PYPI_PASSWORD |
Then run the following command:
make publish
[code-climate-image]: https://codeclimate.com/github/uktrade/directory-client-core/badges/issue_count.svg
[code-climate]: https://codeclimate.com/github/uktrade/directory-client-core
[circle-ci-image]: https://circleci.com/gh/uktrade/directory-client-core/tree/master.svg?style=svg
[circle-ci]: https://circleci.com/gh/uktrade/directory-client-core/tree/master
[codecov-image]: https://codecov.io/gh/uktrade/directory-client-core/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/uktrade/directory-client-core
[gemnasium-image]: https://gemnasium.com/badges/github.com/uktrade/directory-client-core.svg
[gemnasium]: https://gemnasium.com/github.com/uktrade/directory-client-core
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for directory_client_core-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fadce64ac2b62742f0641e05580822b87357be3178a556e549ddb9d33028f7ef |
|
MD5 | 77467ece3b2623a86b301de0226e37e9 |
|
BLAKE2b-256 | 6bb09110db66befed7bac1dafb115f02981c4aa376067c64d2cfca1bb303b444 |