Python API client for Export Directory Companies House.
Project description
# directory-companies-house-search-client
[![circle-ci-image]][circle-ci]
[![codecov-image]][codecov]
[![pypi-image]][pypi]
**Export Directory internal Companies House search client.**
---
## Requirements
## Installation
```shell
pip install directory-ch-client
```
## Usage
```python
from directory_ch_client.client import DirectoryCHClient
client = DirectoryCHClient(
base_url="https://dev.chsearch.directory.uktrade.io",
api_key=api_key
)
```
## Development
$ git clone https://github.com/uktrade/directory-companies-house-search-client
$ cd directory-companies-house-search-client
$ make
## 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 |
| --------------------------- |
| DIT_PYPI_USERNAME |
| DIT_PYPI_PASSWORD |
Then run the following command:
make publish
[circle-ci-image]: https://circleci.com/gh/uktrade/directory-companies-house-search-client/tree/master.svg?style=svg
[circle-ci]: https://circleci.com/gh/uktrade/directory-companies-house-search-client/tree/master
[codecov-image]: https://codecov.io/gh/uktrade/directory-companies-house-search-client/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/uktrade/directory-companies-house-search-client
[pypi-image]: https://badge.fury.io/py/directory-ch-client.svg
[pypi]: https://badge.fury.io/py/directory-ch-client
[![circle-ci-image]][circle-ci]
[![codecov-image]][codecov]
[![pypi-image]][pypi]
**Export Directory internal Companies House search client.**
---
## Requirements
## Installation
```shell
pip install directory-ch-client
```
## Usage
```python
from directory_ch_client.client import DirectoryCHClient
client = DirectoryCHClient(
base_url="https://dev.chsearch.directory.uktrade.io",
api_key=api_key
)
```
## Development
$ git clone https://github.com/uktrade/directory-companies-house-search-client
$ cd directory-companies-house-search-client
$ make
## 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 |
| --------------------------- |
| DIT_PYPI_USERNAME |
| DIT_PYPI_PASSWORD |
Then run the following command:
make publish
[circle-ci-image]: https://circleci.com/gh/uktrade/directory-companies-house-search-client/tree/master.svg?style=svg
[circle-ci]: https://circleci.com/gh/uktrade/directory-companies-house-search-client/tree/master
[codecov-image]: https://codecov.io/gh/uktrade/directory-companies-house-search-client/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/uktrade/directory-companies-house-search-client
[pypi-image]: https://badge.fury.io/py/directory-ch-client.svg
[pypi]: https://badge.fury.io/py/directory-ch-client
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_ch_client-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6caa181630734f06b64951b2b8b8fa82744781799ed0e4777e94be0288c2e9b0 |
|
MD5 | 571ddb0e2f12c00fafca0196ccfe8ff4 |
|
BLAKE2b-256 | bb6b6bce8552aa7e46bd30837d28c0024bde23869d0bcfe3c46367165e8b712c |