Metadata-Version: 2.0
Name: directory-cms-client
Version: 0.0.1
Summary: Python API client for Directory CMS.
Home-page: https://github.com/uktrade/directory-cms-client
Author: Department for International Trade
Author-email: UNKNOWN
License: MIT
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Requires-Dist: certifi (==2018.1.18)
Requires-Dist: chardet (==3.0.4)
Requires-Dist: directory-client-core (==0.0.1)
Requires-Dist: django (==1.11.5)
Requires-Dist: djangorestframework (==3.4.7)
Requires-Dist: idna (==2.6)
Requires-Dist: mohawk (==0.3.4)
Requires-Dist: monotonic (==1.2)
Requires-Dist: pkginfo (==1.4.1)
Requires-Dist: pytz (==2017.2)
Requires-Dist: requests-toolbelt (==0.8.0)
Requires-Dist: requests (==2.18.4)
Requires-Dist: sigauth (==2.1.0)
Requires-Dist: six (==1.11.0)
Requires-Dist: tqdm (==4.19.6)
Requires-Dist: twine (==1.9.1)
Requires-Dist: urllib3 (==1.22)

# directory-cms-client

[![code-climate-image]][code-climate]
[![circle-ci-image]][circle-ci]
[![codecov-image]][codecov]
[![gemnasium-image]][gemnasium]

**Directory CMS client.**

Client for the Directory Content Management read-only API.
---

## Requirements

## Installation

```shell
pip install -e git+https://git@github.com/uktrade/directory-cms-client.git@0.0.2#egg=directory-cms-client
```

## Usage

```python
from directory_cms_client import DirectoryCMSClient

cms_client = DirectoryCMSClient(
    base_url="https://directory-cms-dev.herokuapp.com",
    api_key=api_key
)
```


## Development

    $ git clone https://github.com/uktrade/directory-cms-client
    $ cd directory-cms-client

## 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-cms-client/badges/issue_count.svg
[code-climate]: https://codeclimate.com/github/uktrade/directory-cms-client

[circle-ci-image]: https://circleci.com/gh/uktrade/directory-cms-client/tree/master.svg?style=svg
[circle-ci]: https://circleci.com/gh/uktrade/directory-cms-client/tree/master

[codecov-image]: https://codecov.io/gh/uktrade/directory-cms-client/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/uktrade/directory-cms-client

[gemnasium-image]: https://gemnasium.com/badges/github.com/uktrade/directory-cms-client.svg
[gemnasium]: https://gemnasium.com/github.com/uktrade/directory-cms-client


