directory-constants


Namedirectory-constants JSON
Version 6.6.0 PyPI version JSON
download
home_pagehttps://github.com/uktrade/directory-constants
SummaryConstant values shared between Directory apps.
upload_time2018-04-16 13:48:13
maintainer
docs_urlNone
authorDepartment for International Trade
requires_python
licenseMIT
keywords
VCS
bugtrack_url
requirements django pytz
Travis-CI No Travis.
coveralls test coverage
            # directory-constants

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

---

## Requirements

```shell
pip install -r requirements.txt
```

## Installation

```shell
pip install -e git+https://git@github.com/uktrade/directory-constants.git@0.0.1#egg=directory-constants
```

## Usage

```python
# urls.py
from directory_constants import urls as external_urls

url_patterns = urls.url_patterns + [
   ...
]
```

## Development

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

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


[code-climate-image]: https://codeclimate.com/github/uktrade/directory-constants/badges/issue_count.svg
[code-climate]: https://codeclimate.com/github/uktrade/directory-constants

[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

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



            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "keywords": "", 
    "upload_time": "2018-04-16 13:48:13", 
    "requirements": [
        {
            "name": "django", 
            "specs": [
                [
                    ">=", 
                    "1.9"
                ], 
                [
                    "<", 
                    "2.0a1"
                ]
            ]
        }, 
        {
            "name": "pytz", 
            "specs": [
                [
                    "==", 
                    "2017.2"
                ]
            ]
        }
    ], 
    "author": "Department for International Trade", 
    "home_page": "https://github.com/uktrade/directory-constants", 
    "github_user": "uktrade", 
    "download_url": "", 
    "platform": "", 
    "version": "6.6.0", 
    "cheesecake_documentation_id": null, 
    "circle": true, 
    "description": "# directory-constants\n\n[![code-climate-image]][code-climate]\n[![circle-ci-image]][circle-ci]\n[![codecov-image]][codecov]\n[![gemnasium-image]][gemnasium]\n\n---\n\n## Requirements\n\n```shell\npip install -r requirements.txt\n```\n\n## Installation\n\n```shell\npip install -e git+https://git@github.com/uktrade/directory-constants.git@0.0.1#egg=directory-constants\n```\n\n## Usage\n\n```python\n# urls.py\nfrom directory_constants import urls as external_urls\n\nurl_patterns = urls.url_patterns + [\n   ...\n]\n```\n\n## Development\n\n    $ git clone https://github.com/uktrade/directory-constants\n    $ cd directory-constants\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[code-climate-image]: https://codeclimate.com/github/uktrade/directory-constants/badges/issue_count.svg\n[code-climate]: https://codeclimate.com/github/uktrade/directory-constants\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[gemnasium-image]: https://gemnasium.com/badges/github.com/uktrade/directory-constants.svg\n[gemnasium]: https://gemnasium.com/github.com/uktrade/directory-constants\n\n\n", 
    "lcname": "directory-constants", 
    "bugtrack_url": null, 
    "github": true, 
    "coveralls": true, 
    "name": "directory-constants", 
    "license": "MIT", 
    "travis_ci": false, 
    "github_project": "directory-constants", 
    "summary": "Constant values shared between Directory apps.", 
    "split_keywords": [], 
    "author_email": "", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2018-04-16T13:48:13", 
            "comment_text": "", 
            "python_version": "py3", 
            "url": "https://pypi.python.org/packages/67/58/ef1930cf82bbc33b4e8e6a89c2d1bd53369fe2bf23af73f75d678245bf98/directory_constants-6.6.0-py3-none-any.whl", 
            "md5_digest": "d8ec1cdea82e0cd39534e8198bec1813", 
            "downloads": 0, 
            "filename": "directory_constants-6.6.0-py3-none-any.whl", 
            "packagetype": "bdist_wheel", 
            "path": "67/58/ef1930cf82bbc33b4e8e6a89c2d1bd53369fe2bf23af73f75d678245bf98/directory_constants-6.6.0-py3-none-any.whl", 
            "digests": {
                "sha256": "71167dd3c037fc5b891b023ef0dd617d8c397c7c982ef32e7ddc5de8dfc883e9", 
                "md5": "d8ec1cdea82e0cd39534e8198bec1813"
            }, 
            "sha256_digest": "71167dd3c037fc5b891b023ef0dd617d8c397c7c982ef32e7ddc5de8dfc883e9", 
            "size": 16440
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}