Skip to main content

Django validators for Export Directory.

Project description

# directory-validators
[Directory of UK Exporters validators](https://www.directory.exportingisgreat.gov.uk/)

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

---

## Requirements

## Installation

```shell
pip install directory_validators

```

## Usage

```python
from directory_validators import enrolment

enrolment.validate_company_number('12345678')
enrolment.validate_email('test@example.com')
```


## Development

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


## Testing
$ py.test .


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

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

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

[pypi-image]: https://badge.fury.io/py/directory-validators.svg
[pypi]: https://badge.fury.io/py/directory-validators


Project details


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

directory_validators-5.1.0-py3-none-any.whl (31.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page