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
[![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
Close
Hashes for directory_constants-6.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 07cdcee584821e61a3bf316311419b62ffef8e37dfb73729d9121e410ca01505 |
|
MD5 | b45b3d1e54bc48360ef7f5fbc79dc084 |
|
BLAKE2b-256 | bd06d2d5c7f1cdded590689026a1d63e0f101c31e46dc3f0b30c4521f06ceb52 |