Commit 25865257 authored by Broughton, Mitchell's avatar Broughton, Mitchell
Browse files

bump common version

parent 2a1b3d2c

README.md

+9 −9
Original line number Diff line number Diff line
@@ -7,9 +7,9 @@ Everything is configurable with environmental variables. 


### Installation via pip



Run this command to install version 0.1.17 (latest) via pip:

Run this command to install version 0.1.18 (latest) via pip:



`python3 -m pip --no-cache-dir install common==0.1.17 --index-url https://code.ornl.gov/api/v4/projects/10568/packages/pypi/simple  --trusted-host code.ornl.gov`

`python3 -m pip --no-cache-dir install common==0.1.18 --index-url https://code.ornl.gov/api/v4/projects/10568/packages/pypi/simple  --trusted-host code.ornl.gov`

This will install latest (not recommended):



`python3 -m pip --no-cache-dir install common --index-url https://code.ornl.gov/api/v4/projects/10568/packages/pypi/simple  --trusted-host code.ornl.gov`
@@ -26,13 +26,13 @@ To initiate a release, increment the value in `COMMON_VERSION` run `./release.sh 


### Configuration via Environment Variables

Below is a list of environmental variables and what they do:

- DATABASE_TIMEOUT: an integer representing the seconds to wait before deciding a timeout occurred.

- DATABASE_DB: a string representing the database to connect to

- DATABASE_USER: a string representing the user to connect to the database as

- DATABASE_PW: a string representing the password for the DATABASE_USER

- DATABASE_HOST: a string representing the hostname or IP address hosting the database

- DATABASE_PORT: an integer representing the port to connect to the database on

- DATABASE_SCHEMA: a string representing the schema to default to when creating a database connection

- DATABASE_TIMEOUT, PG_TIMEOUT: an integer representing the seconds to wait before deciding a timeout occurred.

- DATABASE_DB, PG_DATABASE: a string representing the database to connect to

- DATABASE_USER, PG_USER: a string representing the user to connect to the database as

- DATABASE_PW, PG_PASSWORD: a string representing the password for the DATABASE_USER

- DATABASE_HOST, PG_HOST: a string representing the hostname or IP address hosting the database

- DATABASE_PORT, PG_PORT: an integer representing the port to connect to the database on

- DATABASE_SCHEMA, PG_SCHEMA: a string representing the schema to default to when creating a database connection



These evironmental variables have been assigned default values for the Docker container in the file `envfile`, which is called in `docker-compose.yaml` and `docker-compose.test.yaml`

src/setup.py

+1 −1
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ import os 
from setuptools import setup



# update version information here

_version = '0.1.17' # '0.1.14'

_version = '0.1.18' # '0.1.14'



# packages

_packages = ['common', 'common.mixins']