Skip to main content

Constant values shared between Directory apps.

Project description

# 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


Project details


Release history Release notifications | RSS feed

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

If you're not sure about the file name format, learn more about wheel file names.

directory_constants-6.7.0-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file directory_constants-6.7.0-py3-none-any.whl.

File metadata

File hashes

Hashes for directory_constants-6.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c5ae26663d9b461bc95a0024963f7d6ce878b3d05d7f2ac5dbc6f783296d2890
MD5 8a036e0cdb280e60e233d2f4c860792e
BLAKE2b-256 27269253aac87931757fab5654ca445509f44c77ebcdb1dc2bb0abe6749edc8a

See more details on using hashes here.

Supported by

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