search

IndEcol / IE_data_commons

Code and documentation for a commons of structured industrial ecology data
MIT License
23 stars 2 forks source link

Provide templates for path and password files #3

Closed nheeren closed 6 years ago

nheeren commented 6 years ago

For obvious reasons, IEDC_Paths.py and IEDC_PW.py are excluded in .gitignore.

However, to make the life of newcomers easier, you could provide templates with fake paths / credentials. Then the user would know how the file ought to look like, where to get the data. He could then simply copy it and replace the placeholders. A dummy example for IEDC_PW-template.py:

server = "*please contact admin@uni-freiburg.de*"
database = "*please contact admin@uni-freiburg.de*"
IEDC_write_access_user = "*please contact admin@uni-freiburg.de*"
IEDC_write_access_user_PW = "*please contact admin@uni-freiburg.de*"
IEDC_port = "*please contact admin@uni-freiburg.de*"

This partly applies to #2 as well.

nheeren commented 6 years ago

Made a suggestion in https://github.com/IndEcol/IEDC_tools. This may possibly merged into the repo here.