diff --git a/docs/examples/try_me_out/fixtures.ipynb b/docs/examples/try_me_out/fixtures.ipynb new file mode 100644 index 00000000..43e88156 --- /dev/null +++ b/docs/examples/try_me_out/fixtures.ipynb @@ -0,0 +1,98 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Try out the VortexaSDK" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "First let's import our requirements" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": { + "tags": [] + }, + "outputs": [], + "source": [ + "from datetime import datetime\n", + "import vortexasdk as v" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Now let's load a dataframe of fixtures fixed at the start of January, 2020." + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "You'll need to enter your Vortexa API key when prompted." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": { + "tags": [] + }, + "outputs": [], + "source": [ + "df = v.Fixtures().search(\n", + " filter_time_field=\"fixing_timestamp\",\n", + " filter_time_min=datetime(2020, 1, 1),\n", + " filter_time_max=datetime(2020, 1, 2),\n", + ").to_df()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": { + "tags": [] + }, + "outputs": [], + "source": [ + "df.head()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "That's it! You've successfully loaded data using the Vortexa SDK. Check out https://vortechsa.github.io/python-sdk/ for more examples" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.7.6" + } + }, + "nbformat": 4, + "nbformat_minor": 4 +}