Merge pull request #12 from zbrookle/installation

Installation

Author: zbrookle

.gitattributes

@@ -0,0 +1 @@
+dataframe_sql/_version.py export-subst

LICENSE.txt

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2011-2020, Open source contributors.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

@@ -0,0 +1,2 @@
+include versioneer.py
+include dataframe_sql/_version.py

README.md

@@ -2,8 +2,32 @@
 
 ![CI](https://github.com/zbrookle/dataframe_sql/workflows/CI/badge.svg)
 
-## Execution plan
+## Installation
+
+```bash
+pip install dataframe_sql
+```
+
+## Usage
+
+In this simple example, a DataFrame is read in from a csv and then using the query
+function you can produce a new DataFrame from the sql query.
+
+```python
+from pandas import read_csv
+from dataframe_sql import register_temp_table, query
 
+my_table = read_csv("some_file.csv")
+
+register_temp_table(my_table)
+
+query(""""select * from my_table""")
+```
+
+The package currently only supports pandas but there are plans to support dask and
+rapids in the future.
+
+## Execution plan
 
 ### Values of certain "random" variables
 In certain places it was necessary to create functionality that pandas doesn't support

ci/code_checks.sh

@@ -132,7 +132,6 @@ if [[ -z "$CHECK" || "$CHECK" == "patterns" ]]; then
     # Check for the following code in testing: `unittest.mock`, `mock.Mock()` or `mock.patch`
     MSG='Check that unittest.mock is not used (pytest builtin monkeypatch fixture should be used instead)' ; echo $MSG
     invgrep -r -E --include '*.py' '(unittest(\.| import )mock|mock\.Mock\(\)|mock\.patch)' dataframe_sql/tests/
-    echo $?
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
     MSG='Check for extra blank lines after the class definition' ; echo $MSG

dataframe_sql/__init__.py

@@ -1,2 +1,7 @@
 # flake8: noqa
 from dataframe_sql.sql_select_query import query, register_temp_table, remove_temp_table
+
+from ._version import get_versions
+
+__version__ = get_versions()["version"]
+del get_versions