Skip to main content

Python API client for Export Directory Companies House.

Project description

directory-companies-house-search-client

code-climate-image circle-ci-image codecov-image pypi-image semver-image

Export Directory internal Companies House search client.


Requirements

Installation

pip install directory-ch-client

Usage

from directory_ch_client.client import client

response = client.company.search_companies(query='Foo Bar')

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page