Python API client for Export Directory.
Project description
# directory-api-client-external
[![code-climate-image]][code-climate]
[![circle-ci-image]][circle-ci]
[![codecov-image]][codecov]
[![gemnasium-image]][gemnasium]
**Export Directory external API client.**
---
## Installation
```shell
pip install directory-api-client-external
```
## Usage
```python
from directory_api_external.client import DirectoryAPIClient
directory_client = DirectoryAPIClient(
base_url="https://find-a-buyer.export.great.gov.uk/api",
api_key=api_key
)
```
## Development
$ git clone https://github.com/uktrade/directory-api-client-external
$ cd directory-api-client-external
## 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-api-client-external/badges/issue_count.svg
[code-climate]: https://codeclimate.com/github/uktrade/directory-api-client-external
[circle-ci-image]: https://circleci.com/gh/uktrade/directory-api-client-external/tree/master.svg?style=svg
[circle-ci]: https://circleci.com/gh/uktrade/directory-api-client-external/tree/master
[codecov-image]: https://codecov.io/gh/uktrade/directory-api-client-external/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/uktrade/directory-api-client-external
[gemnasium-image]: https://gemnasium.com/badges/github.com/uktrade/directory-api-client-external.svg
[gemnasium]: https://gemnasium.com/github.com/uktrade/directory-api-client-external
[![code-climate-image]][code-climate]
[![circle-ci-image]][circle-ci]
[![codecov-image]][codecov]
[![gemnasium-image]][gemnasium]
**Export Directory external API client.**
---
## Installation
```shell
pip install directory-api-client-external
```
## Usage
```python
from directory_api_external.client import DirectoryAPIClient
directory_client = DirectoryAPIClient(
base_url="https://find-a-buyer.export.great.gov.uk/api",
api_key=api_key
)
```
## Development
$ git clone https://github.com/uktrade/directory-api-client-external
$ cd directory-api-client-external
## 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-api-client-external/badges/issue_count.svg
[code-climate]: https://codeclimate.com/github/uktrade/directory-api-client-external
[circle-ci-image]: https://circleci.com/gh/uktrade/directory-api-client-external/tree/master.svg?style=svg
[circle-ci]: https://circleci.com/gh/uktrade/directory-api-client-external/tree/master
[codecov-image]: https://codecov.io/gh/uktrade/directory-api-client-external/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/uktrade/directory-api-client-external
[gemnasium-image]: https://gemnasium.com/badges/github.com/uktrade/directory-api-client-external.svg
[gemnasium]: https://gemnasium.com/github.com/uktrade/directory-api-client-external
Project details
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_api_external-4.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed12bb0101037eb6bf921607e08f502bb687310d182fc34f97e611f5c6b5757a |
|
MD5 | c0cfa14b2a8d38b8cfbefbce5d893e14 |
|
BLAKE2b-256 | 4dc0238120d4dc723cc8d86535bd9dcbfcba947625e56550a43cd384afea1a19 |