Metadata-Version: 2.1
Name: directory-validators
Version: 9.3.0
Summary: Django validators for GREAT.
Home-page: https://github.com/uktrade/directory-validators
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 :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.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.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
Requires-Dist: django (<=4.2,>=3.2.18)
Requires-Dist: olefile (<1.0.0,>=0.44)
Requires-Dist: Pillow (>=9.0.1)
Requires-Dist: pytz (<=2023.3,>=2017.2)
Requires-Dist: urllib3 (<2.0.0,>=1.26.5)
Provides-Extra: test
Requires-Dist: lorem (==0.1.1) ; extra == 'test'
Requires-Dist: ansicolors (==1.1.8) ; extra == 'test'
Requires-Dist: gitdb (==4.0.10) ; extra == 'test'
Requires-Dist: gitpython (==3.1.31) ; extra == 'test'
Requires-Dist: GitPython ; extra == 'test'
Requires-Dist: flake8 (==3.7.8) ; extra == 'test'
Requires-Dist: smmap (==5.0.0) ; extra == 'test'
Requires-Dist: toml (==0.10.2) ; extra == 'test'
Requires-Dist: requests-toolbelt (==0.8.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'
Requires-Dist: vulture (<2.0.0,>=1.0.0) ; extra == 'test'
Requires-Dist: hvac (<1.0.0,>=0.9.5) ; extra == 'test'
Requires-Dist: attrs (==23.1.0) ; extra == 'test'
Requires-Dist: certifi (==2022.12.7) ; extra == 'test'
Requires-Dist: charset-normalizer (==3.1.0) ; extra == 'test'
Requires-Dist: coverage[toml] (==7.2.5) ; extra == 'test'
Requires-Dist: execnet (==1.9.0) ; extra == 'test'
Requires-Dist: idna (==3.4) ; extra == 'test'
Requires-Dist: iniconfig (==2.0.0) ; extra == 'test'
Requires-Dist: packaging (==23.1) ; extra == 'test'
Requires-Dist: pluggy (==0.13.1) ; extra == 'test'
Requires-Dist: py (==1.11.0) ; extra == 'test'
Requires-Dist: pytest (==6.2.1) ; extra == 'test'
Requires-Dist: pytest-codecov (==0.5.1) ; extra == 'test'
Requires-Dist: pytest-cov (==4.0.0) ; extra == 'test'
Requires-Dist: pytest-django (==3.10.0) ; extra == 'test'
Requires-Dist: pytest-sugar (==0.9.7) ; extra == 'test'
Requires-Dist: pytest-xdist (==3.2.1) ; extra == 'test'
Requires-Dist: requests (==2.30.0) ; extra == 'test'
Requires-Dist: termcolor (==2.3.0) ; extra == 'test'
Requires-Dist: tomli (==2.0.1) ; extra == 'test'
Requires-Dist: urllib3 (==1.26.15) ; extra == 'test'
Requires-Dist: codecov ; extra == 'test'

# 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]
[![semver-image]][semver]

---

## 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

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


