Commit 1ca145b4 authored by Grant, Josh's avatar Grant, Josh
Browse files

update with additional information

parent 89fc7679
Loading
Loading
Loading
Loading
+3 −0
Original line number Diff line number Diff line
# swap files
*.sw[op]
# python build files
build/

src/LICENSE

0 → 100644
+19 −0
Original line number Diff line number Diff line
Copyright 2021 ORNL

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in 
the Software without restriction, including without limitation the rights to 
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
of the Software, and to permit persons to whom the Software is furnished to do 
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
SOFTWARE.

src/README.md

0 → 100644
+15 −0
Original line number Diff line number Diff line
# Common Package

This package contains an extensible Database metaclass with a generic query
function that is usable out of the box. Everything is configurable with
environmental variables.

## Environmental 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
+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'
_version = '0.1.1'

# packages
_packages = ['cp']
+1 −1
Original line number Diff line number Diff line
@@ -10,4 +10,4 @@ echo -e "$BANNER"
python3 setup.py sdist bdist_wheel
python3 -m twine upload --repository gitlab dist/* --verbose \
  --config-file pypirc.cfg
rm -rf dist/ cp.egg-info/
rm -rf dist/ cp.egg-info/ build/