Metadata-Version: 2.0
Name: directory-components
Version: 2.6.1
Summary: Shared components library for Export Directory.
Home-page: https://github.com/uktrade/directory-components
Author: Department for International Trade
Author-email: UNKNOWN
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
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: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: django (<2.0a1,>=1.9)
Requires-Dist: export-elements (<1.0.0,>=0.10.2)
Requires-Dist: pip (==9.0.1)

# directory-components

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

**Reusable components used across the directory applications for the Department for International Trade.**

---

## Installation

```shell
pip install directory-components
```

## Development

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


## Demo

To view the components in the browser run the following command:

    $ make run_demo

and go to `0.0.0.0:9000` in your browser

## Auto update services dependency

To automatically update the dependences of services that use this library call the following command:

    $ make update

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

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

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

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


