Constant values shared between Directory apps.
Project description
# directory-constants
[![circle-ci-image]][circle-ci]
[![codecov-image]][codecov]
[![pypi-image]][pypi]
---
## 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
[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
[![circle-ci-image]][circle-ci]
[![codecov-image]][codecov]
[![pypi-image]][pypi]
---
## 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
[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
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file directory_constants-8.0.0-py3-none-any.whl.
File metadata
- Download URL: directory_constants-8.0.0-py3-none-any.whl
- Upload date:
- Size: 16.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.9.1 pkginfo/1.4.2 requests/2.19.1 setuptools/28.8.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.5.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c2f6b66800dddb8c6bfa81fa89aee15db37fe30c2f3c396e7aceb650bd3da478
|
|
| MD5 |
74590e1d65bb7652ea68db89f8eb9410
|
|
| BLAKE2b-256 |
c8b684665dc6ca18f15c2d39a586b8ee1479b4b6895f56308421dde40df1eac7
|