From 65915a97a31c33fd9a9f3b98ea0083c31330b3c0 Mon Sep 17 00:00:00 2001 From: Matt Bernhardt Date: Wed, 23 Jan 2019 20:42:20 -0500 Subject: [PATCH 1/2] Updates readme with installation instructions --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index da44e48..9c3bc8e 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,41 @@ Trapp provides several tools for the user to work with soccer data: Each of these will be described in more detail as the project progresses. For now, efforts are focused on the first tool, an importer capable of harvesting spreadsheet data into the appropriate database tables. +## Installing + +My hope is that this project can be installed in a comparable way to other python libraries. When I do so myself, the steps look like this: + +``` +git clone git@github.com:matt-bernhardt/trapp.git +cd trapp +pip install -r requirements.txt +python setup.py install +``` + +Following this, I establish the database credentials - which exist as four environment variables: + +* TRAPP_DBHOST +* TRAPP_DBPWD +* TRAPP_DBSCHEMA +* TRAPP_DBUSER + +For confirmation that everything is ready to go, the `check-db` verb is useful. The output should look something like: + +``` +(myvenv) $ trapp -v check-db +Checking database connection + +Credentials: +dbuser: username +dbpwd: password +dbhost: host +dbschema: schema + + +MySQLCursorBuffered: (Nothing executed yet) +Warnings: None +``` + ## For more information More information about this project can be found on the [Massive Report Data blog](http://www.massivereportdata.com/blog). To contact the author, please email Matt Bernhardt at matt [at] massivereportdata [dot] com or on Twitter at [@BernhardtSoccer](https://twitter.com/bernhardtsoccer). \ No newline at end of file From 10ead6f9c187146a595195225407010809952eaa Mon Sep 17 00:00:00 2001 From: Matt Bernhardt Date: Wed, 23 Jan 2019 20:47:13 -0500 Subject: [PATCH 2/2] Updates version to beta2 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 84d11f2..227b949 100644 --- a/setup.py +++ b/setup.py @@ -13,7 +13,7 @@ setup( name='trapp', - version='0.5.0-beta1', + version='0.5.0b2', description='Link, analyze, and extend soccer data', url='https://github.com/matt-bernhardt/trapp', license=license,