Metadata-Version: 2.1
Name: directory-ch-client
Version: 3.0.3
Summary: Python API client for Export Directory Companies House.
Home-page: https://github.com/uktrade/directory-companies-house-search-client
Author: Department for International Trade
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
Requires-Dist: django (<4.0.0,>=3.2.18)
Requires-Dist: requests (<3.0.0,>=2.18.4)
Requires-Dist: monotonic (<3.0,>=1.2)
Requires-Dist: directory-client-core (<8.0.0,>=6.1.0)
Provides-Extra: test
Requires-Dist: pytest (==7.1.3) ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-codecov ; extra == 'test'
Requires-Dist: GitPython ; extra == 'test'
Requires-Dist: flake8 (==5.0.4) ; extra == 'test'
Requires-Dist: requests-mock (==1.1.0) ; extra == 'test'
Requires-Dist: twine (<2.0.0,>=1.11.0) ; extra == 'test'
Requires-Dist: wheel (<1.0.0,>=0.31.0) ; extra == 'test'
Requires-Dist: setuptools (<39.0.0,>=38.6.0) ; extra == 'test'

# directory-companies-house-search-client

[![code-climate-image]][code-climate]
[![circle-ci-image]][circle-ci]
[![codecov-image]][codecov]
[![pypi-image]][pypi]
[![semver-image]][semver]

**Export Directory internal Companies House search client.**

---

## Requirements

## Installation

```shell
pip install directory-ch-client
```

## Usage

```python
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

[code-climate-image]: https://codeclimate.com/github/uktrade/directory-companies-house-search-client/badges/issue_count.svg
[code-climate]: https://codeclimate.com/github/uktrade/directory-companies-house-search-client

[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

[semver-image]: https://img.shields.io/badge/Versioning%20strategy-SemVer-5FBB1C.svg
[semver]: https://semver.org


