Metadata-Version: 2.1
Name: functional-functions
Version: 0.2.6
Summary: Commonly used functions by the Compass FBI Team
Home-page: https://github.com/UrbanCompass/Functional-Functions
Author: Lawrence Chin
Author-email: lawrence.chin@compass.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: snowflake-connector-python (>=2.1.1)
Requires-Dist: snowflake-sqlalchemy (>=1.2.4)
Requires-Dist: pandas (>=1.1.4)
Requires-Dist: numpy (>=1.19.4)
Requires-Dist: pytz (>=2020.4)

# Functional-Functions
Created by the FBI Compass team, this package contains our team's most commonly used and useful functions

# About
Contents include functions for connecting to snowflake, saving and loading pickles. For help with what functions are available, please run help()

# Usage
Currently all files are in the init.py. Import each function as needed. First time users are encouraged to import and run help() for more info.

````python
import functional_functions
````

````python
from functional_functions import help, query_snowflake
````

# Troubleshooting/Prequisite/Additional Notes
Some functions, especially the connections, are built off of a settings.py file which stores local creds. You can view a sample settings file called 'settings.py.sample' in the included files. Obviously feel free to use another method to store and provide creds if you want.

However if you are using 'settings.py' as your creds file, you will need to place it in your overall site-packages folder.

**NOTE**: There is currrently an issue where an additional functional_functions.py file will appear in the package. Please disregard that file for now as the actual code is stored in __init__.py. 

**NOTE**: Yes I know code shouldnt be stored in __init__.py, but I also am learning packages and such!.

# Help/Issues/Bugs
Please contact lawrence.chin@compass.com if there are any questions, bugs, or issues.

