directory-constants


Namedirectory-constants JSON
Version 24.1.2 PyPI version JSON
download
home_pagehttps://github.com/uktrade/directory-constants
SummaryConstant values shared between Directory apps.
upload_time2024-03-05 14:22:22
maintainer
docs_urlNone
authorDepartment for Business and Trade
requires_python
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # directory-constants

[![circle-ci-image]][circle-ci]
[![codecov-image]][codecov]
[![pypi-image]][pypi]
[![semver-image]][semver]

---

## Installation

```shell
pip install directory-constants
```

### Environment variables

To change the default value of urls add the following to your settings.py:

| Setting name                                    | default value                                         |
| ----------------------------------------------- | ----------------------------------------------------- |
| DIRECTORY_CONSTANTS_URL_GREAT_DOMESTIC          | https://www.great.gov.uk                              |
| DIRECTORY_CONSTANTS_URL_SINGLE_SIGN_ON          | https://www.great.gov.uk/sso/                         |
| DIRECTORY_CONSTANTS_URL_EXPORT_OPPORTUNITIES    | https://www.great.gov.uk/export-opportunities/        |
| DIRECTORY_CONSTANTS_URL_FIND_A_BUYER            | https://www.great.gov.uk/find-a-buyer/                |
| DIRECTORY_CONSTANTS_URL_SELLING_ONLINE_OVERSEAS | https://www.great.gov.uk/selling-online-overseas/     |
| DIRECTORY_CONSTANTS_URL_FIND_A_SUPPLIER         | https://www.great.gov.uk/trade/                      |
| DIRECTORY_CONSTANTS_URL_INVEST                  | https://invest.great.gov.uk                           |
| DIRECTORY_CONSTANTS_URL_EVENTS                  | https://www.events.trade.gov.uk                       |


## Development

    $ git clone https://github.com/uktrade/directory-constants
    $ cd directory-constants
    [Create and activate your virtual environment]
    $ make test_requirements

## Testing
	$ make 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


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

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

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

[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-constants",
    "name": "directory-constants",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Department for Business and Trade",
    "author_email": "",
    "download_url": "",
    "platform": null,
    "description": "# directory-constants\n\n[![circle-ci-image]][circle-ci]\n[![codecov-image]][codecov]\n[![pypi-image]][pypi]\n[![semver-image]][semver]\n\n---\n\n## Installation\n\n```shell\npip install directory-constants\n```\n\n### Environment variables\n\nTo change the default value of urls add the following to your settings.py:\n\n| Setting name                                    | default value                                         |\n| ----------------------------------------------- | ----------------------------------------------------- |\n| DIRECTORY_CONSTANTS_URL_GREAT_DOMESTIC          | https://www.great.gov.uk                              |\n| DIRECTORY_CONSTANTS_URL_SINGLE_SIGN_ON          | https://www.great.gov.uk/sso/                         |\n| DIRECTORY_CONSTANTS_URL_EXPORT_OPPORTUNITIES    | https://www.great.gov.uk/export-opportunities/        |\n| DIRECTORY_CONSTANTS_URL_FIND_A_BUYER            | https://www.great.gov.uk/find-a-buyer/                |\n| DIRECTORY_CONSTANTS_URL_SELLING_ONLINE_OVERSEAS | https://www.great.gov.uk/selling-online-overseas/     |\n| DIRECTORY_CONSTANTS_URL_FIND_A_SUPPLIER         | https://www.great.gov.uk/trade/                      |\n| DIRECTORY_CONSTANTS_URL_INVEST                  | https://invest.great.gov.uk                           |\n| DIRECTORY_CONSTANTS_URL_EVENTS                  | https://www.events.trade.gov.uk                       |\n\n\n## Development\n\n    $ git clone https://github.com/uktrade/directory-constants\n    $ cd directory-constants\n    [Create and activate your virtual environment]\n    $ make test_requirements\n\n## Testing\n\t$ make test\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[circle-ci-image]: https://circleci.com/gh/uktrade/directory-constants/tree/master.svg?style=svg\n[circle-ci]: https://circleci.com/gh/uktrade/directory-constants/tree/master\n\n[codecov-image]: https://codecov.io/gh/uktrade/directory-constants/branch/master/graph/badge.svg\n[codecov]: https://codecov.io/gh/uktrade/directory-constants\n\n[pypi-image]: https://badge.fury.io/py/directory-constants.svg\n[pypi]: https://badge.fury.io/py/directory-constants\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": "Constant values shared between Directory apps.",
    "version": "24.1.2",
    "project_urls": {
        "Homepage": "https://github.com/uktrade/directory-constants"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "73de57e0f8363161f41bfb9345296e968218838a3c7f3be11c0525fca3d0ae95",
                "md5": "29a06b01fa04c48e22b5e13d449627bc",
                "sha256": "32b9aeead609728eb4ed3c86bfa852f664eaf10ce3f294f1b79a84655b7731af"
            },
            "downloads": -1,
            "filename": "directory_constants-24.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "29a06b01fa04c48e22b5e13d449627bc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 54307,
            "upload_time": "2024-03-05T14:22:22",
            "upload_time_iso_8601": "2024-03-05T14:22:22.402322Z",
            "url": "https://files.pythonhosted.org/packages/73/de/57e0f8363161f41bfb9345296e968218838a3c7f3be11c0525fca3d0ae95/directory_constants-24.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-05 14:22:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "uktrade",
    "github_project": "directory-constants",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": false,
    "circle": true,
    "lcname": "directory-constants"
}
        
Elapsed time: 0.20897s