diff options
| -rw-r--r-- | README.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..0e27df0 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ + +# Maconomy Hours + +A simple tool for sending reminder mails based on Deltek Maconomy. +Currently it uses direct database access, and works with either Oracle DB or MSSQL. + + +Help instructions are available using -h. +You need to supply a configuration file that contains database and mail information. +See `config.cfg.dist` for a skeleton + + +## Installation + +- Install python 2.7 or 3. +- Install pip packages `pip install -r requirements/mssql.txt` or `pip install -r requirements/oracle.txt` + +### Oracle + +You will need to install the Oracle Client along with the python packages. +You might have some luck with i[this gist](https://gist.github.com/thom-nic/6011715), I did unfortunately not write down how I got `cx_Oracle` to work + + +### MSSQL + +Steps for installing the MSSQL client bindings are taken from [https://docs.microsoft.com/en-us/azure/sql-database/sql-database-connect-query-python](https://docs.microsoft.com/en-us/azure/sql-database/sql-database-connect-query-python) + +- OSX + - Install `msodbcsql` and `mssql-tools` (you might be able to skip `mssql-tool`) + ``` + brew tap microsoft/mssql-release https://github.com/Microsoft/homebrew-mssql-release + brew update + ACCEPT_EULA=y brew install msodbcsql mssql-tools + ``` +- Windows + - Install [MSSQL ODBC Driver](https://www.microsoft.com/en-us/download/details.aspx?id=53339) + - Optionally install [SQL Server Command Line Utilities](https://www.microsoft.com/en-us/download/details.aspx?id=53591) + + + |