# 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
Raw data
{
"_id": null,
"home_page": "https://github.com/uktrade/directory-validators",
"name": "directory-validators",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Department for International Trade",
"author_email": "",
"download_url": "",
"platform": null,
"description": "# directory-validators\n[Directory of UK Exporters validators](https://www.directory.exportingisgreat.gov.uk/)\n\n[![code-climate-image]][code-climate]\n[![circle-ci-image]][circle-ci]\n[![codecov-image]][codecov]\n[![pypi-image]][pypi]\n[![semver-image]][semver]\n\n---\n\n## Requirements\n\n## Installation\n\n```shell\npip install directory_validators\n\n```\n\n## Usage\n\n```python\nfrom directory_validators import enrolment\n\nenrolment.validate_company_number('12345678')\nenrolment.validate_email('test@example.com')\n```\n\n\n## Development\n\n $ git clone https://github.com/uktrade/directory-validators\n $ cd directory-validators\n $ make\n\n\n## Testing\n\t$ py.test .\n\n\n## Publish to PyPI\n\nThe 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:\n\n| Setting |\n| --------------------------- |\n| DIRECTORY_PYPI_USERNAME |\n| DIRECTORY_PYPI_PASSWORD |\n\n\nThen run the following command:\n\n make publish\n\n\n[code-climate-image]: https://codeclimate.com/github/uktrade/directory-validators/badges/issue_count.svg\n[code-climate]: https://codeclimate.com/github/uktrade/directory-validators\n\n[circle-ci-image]: https://circleci.com/gh/uktrade/directory-validators/tree/master.svg?style=svg\n[circle-ci]: https://circleci.com/gh/uktrade/directory-validators/tree/master\n\n[codecov-image]: https://codecov.io/gh/uktrade/directory-validators/branch/master/graph/badge.svg\n[codecov]: https://codecov.io/gh/uktrade/directory-validators\n\n[pypi-image]: https://badge.fury.io/py/directory-validators.svg\n[pypi]: https://badge.fury.io/py/directory-validators\n\n[semver-image]: https://img.shields.io/badge/Versioning%20strategy-SemVer-5FBB1C.svg\n[semver]: https://semver.org\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Django validators for GREAT.",
"version": "9.3.3",
"project_urls": {
"Homepage": "https://github.com/uktrade/directory-validators"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "663e6170a233181e8ac01404bcd394ab4414f7f8cddf452ab78e370bf3ab526b",
"md5": "946e6055fab6032819fe7bd8229ca1f2",
"sha256": "015db827bb1c0f59a0d5665c4bab81f5be24182782945b76262788a57fa695c7"
},
"downloads": -1,
"filename": "directory_validators-9.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "946e6055fab6032819fe7bd8229ca1f2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6529,
"upload_time": "2024-02-20T16:29:30",
"upload_time_iso_8601": "2024-02-20T16:29:30.965700Z",
"url": "https://files.pythonhosted.org/packages/66/3e/6170a233181e8ac01404bcd394ab4414f7f8cddf452ab78e370bf3ab526b/directory_validators-9.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-20 16:29:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "uktrade",
"github_project": "directory-validators",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"circle": true,
"lcname": "directory-validators"
}
JSON
