diff --git a/README.md b/README.md index 2c5ae8b..e11f5d7 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,7 @@ -

Developer Documentation

+

exasol/developer-documentation

-Documentation and resources for data scientists and programmatic users to perform analytics with Exasol and to build applications on top. +Documentation and resources for developing software and data science solutions and applications on top of the Exasol Analytics Engine.

- -# Getting Started -There are three ways to get started with Exasol: -- Download the [community edition](https://www.exasol.com/free-signup-community-edition/) -- Use the [docker version](https://github.com/exasol/docker-db) -- Signup for a free [SaaS trial](https://cloud.exasol.com/signup) - -In the following we are going to use the SaaS version. - -## Setting up the db -Our [main documentation](https://docs.exasol.com/saas/get_started/saas_first_steps.htm) shows you how to create a SaaS account and setup your first database and cluster. -## Installing pyexasol -Once your database is up and running you can connect via any client. From Python we use [PyExasol](https://github.com/exasol/pyexasol). -It can be easily installed via -``` -pip install pyexasol[pandas] -``` - -## Connecting to the db -Connecting to an Exasol database is performed via: -```python -import pyexasol - -C = pyexasol.connect(dsn='', user='sys', password='exasol') -``` -It is slightly different when connecting to a SaaS database as we need a [personal access token](https://docs.exasol.com/saas/administration/access_mngt/access_token.htm): -```python -import pyexasol - -C = pyexasol.connect(dsn='', user='sys', password='') -``` -Finally you can also wrap all credentials into a [local config file](https://exasol.github.io/pyexasol/master/user_guide/local_config.html): -```python -C = pyexasol.connect_local_config('my_exasol') -``` -## Executing SQL -Running your first query is pretty straightforward: -```python -stmt = C.execute("SELECT * FROM EXA_ALL_USERS") - -for row in stmt: - print(row) -``` -It also allows you to load resultsets into a pandas dataframe: -```python -C = pyexasol.connect(dsn='', user='sys', password='exasol', compression=True) - -df = C.export_to_pandas("SELECT * FROM EXA_ALL_USERS") -print(df.head()) -``` - - -# Data Ingestion -## CSV Files -## Parquet Files -## Import from external sources -## HTTP Transport -# Distributed Python (UDFs) -## Intro to UDFs -## Creating and running UDFs -## Debugging UDFs -# Advanced -## move all the other stuff here -# Examples -# Environments -## Jupyter Notebooks -## VSCode -## Positron -# Integrations -## JupySQL -## Pandas -## Ibis -## SQLAlchemy +Checkout the latest [documentation](https://exasol.github.io/developer-documentation/). diff --git a/doc/api.rst b/doc/api.rst deleted file mode 100644 index 246b507..0000000 --- a/doc/api.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _api: - -:octicon:`cpu` API Reference -============================= - diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md index 65f8f82..ce2cac6 100644 --- a/doc/changes/unreleased.md +++ b/doc/changes/unreleased.md @@ -3,4 +3,5 @@ ## Features * #1: Added initial Project Setup - +* #4; Initial documentation version with outline and first fragments +* #6: Translate README to rst and split up sections \ No newline at end of file diff --git a/doc/data_ingestion.rst b/doc/data_ingestion.rst new file mode 100644 index 0000000..f4b3653 --- /dev/null +++ b/doc/data_ingestion.rst @@ -0,0 +1,14 @@ +Data Ingestion +============== + +CSV Files +--------- + +Parquet Files +------------- + +Import from external sources +---------------------------- + +HTTP Transport +-------------- diff --git a/doc/developer_guide.rst b/doc/developer_guide.rst deleted file mode 100644 index 80ef261..0000000 --- a/doc/developer_guide.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _developer_guide: - -:octicon:`tools` Developer Guide -================================ - diff --git a/doc/distributed_python/advanced.rst b/doc/distributed_python/advanced.rst new file mode 100644 index 0000000..a378715 --- /dev/null +++ b/doc/distributed_python/advanced.rst @@ -0,0 +1,2 @@ +Advanced +-------- \ No newline at end of file diff --git a/doc/distributed_python/debugging.rst b/doc/distributed_python/debugging.rst new file mode 100644 index 0000000..a3cd0d6 --- /dev/null +++ b/doc/distributed_python/debugging.rst @@ -0,0 +1,2 @@ +Debugging +--------- \ No newline at end of file diff --git a/doc/distributed_python/index.rst b/doc/distributed_python/index.rst new file mode 100644 index 0000000..7f7478a --- /dev/null +++ b/doc/distributed_python/index.rst @@ -0,0 +1,10 @@ +Distributed Python (UDFs) +========================= + +.. toctree:: + :maxdepth: 1 + + intro + usage + debugging + advanced diff --git a/doc/distributed_python/intro.rst b/doc/distributed_python/intro.rst new file mode 100644 index 0000000..2089e26 --- /dev/null +++ b/doc/distributed_python/intro.rst @@ -0,0 +1,2 @@ +Intro to UDFs +------------- \ No newline at end of file diff --git a/doc/distributed_python/usage.rst b/doc/distributed_python/usage.rst new file mode 100644 index 0000000..8cb812b --- /dev/null +++ b/doc/distributed_python/usage.rst @@ -0,0 +1,2 @@ +Creating and running UDFs +------------------------- \ No newline at end of file diff --git a/doc/environments.rst b/doc/environments.rst new file mode 100644 index 0000000..a41a60c --- /dev/null +++ b/doc/environments.rst @@ -0,0 +1,11 @@ +Environments +============ + +Jupyter Notebooks +----------------- + +VSCode +------ + +Positron +-------- \ No newline at end of file diff --git a/doc/examples.rst b/doc/examples.rst new file mode 100644 index 0000000..7d4d0aa --- /dev/null +++ b/doc/examples.rst @@ -0,0 +1,2 @@ +Examples +======== \ No newline at end of file diff --git a/doc/getting_started.rst b/doc/getting_started.rst new file mode 100644 index 0000000..42f6868 --- /dev/null +++ b/doc/getting_started.rst @@ -0,0 +1,80 @@ + +Getting Started +=============== + +There are three ways to get started with Exasol: + +- Download the `community + edition `__ +- Use the `docker version `__ +- Signup for a free `SaaS trial `__ + +In the following we are going to use the SaaS version. + +Setting up the db +----------------- + +Our `main +documentation `__ +shows you how to create a SaaS account and setup your first database and +cluster. + +Installing pyexasol +------------------- + +Once your database is up and running you can connect via any client. +From Python we use `PyExasol `__. It +can be easily installed via + +:: + + pip install pyexasol[pandas] + +Connecting to the db +-------------------- + +Connecting to an Exasol database is performed via: + +.. code:: python + + import pyexasol + + C = pyexasol.connect(dsn='', user='sys', password='exasol') + +It is slightly different when connecting to a SaaS database as we need a +`personal access +token `__: + +.. code:: python + + import pyexasol + + C = pyexasol.connect(dsn='', user='sys', password='') + +Finally you can also wrap all credentials into a `local config +file `__: + +.. code:: python + + C = pyexasol.connect_local_config('my_exasol') + +Executing SQL +------------- + +Running your first query is pretty straightforward: + +.. code:: python + + stmt = C.execute("SELECT * FROM EXA_ALL_USERS") + + for row in stmt: + print(row) + +It also allows you to load resultsets into a pandas dataframe: + +.. code:: python + + C = pyexasol.connect(dsn='', user='sys', password='exasol', compression=True) + + df = C.export_to_pandas("SELECT * FROM EXA_ALL_USERS") + print(df.head()) diff --git a/doc/index.rst b/doc/index.rst index 5d8564e..1570835 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,35 +1,17 @@ -Documentation of exasol-developer-documentation ------------------------------------------------- +======================= +Developer Documentation +======================= -.. grid:: 1 1 3 2 - :gutter: 2 - :padding: 0 - :class-container: surface - - .. grid-item-card:: :octicon:`person` User Guide - :link: user_guide - :link-type: ref - - Resource for users to understand how to utilize this project and its features. - - .. grid-item-card:: :octicon:`tools` Developer Guide - :link: developer_guide - :link-type: ref - - Instructions and best practices to help developers contribute to the project and set up their development environment. - - .. grid-item-card:: :octicon:`question` FAQ - :link: faq - :link-type: ref - - Frequently asked questsions. +Documentation and resources for data scientists and programmatic users to perform analytics with Exasol and to build applications on top. .. toctree:: :maxdepth: 1 - :hidden: - user_guide - developer_guide - api + getting_started + data_ingestion + distributed_python/index.rst + examples + environments + integrations faq changes/changelog diff --git a/doc/integrations.rst b/doc/integrations.rst new file mode 100644 index 0000000..a4f52de --- /dev/null +++ b/doc/integrations.rst @@ -0,0 +1,14 @@ +Integrations +============ + +JupySQL +------- + +Pandas +------ + +Ibis +---- + +SQLAlchemy +---------- diff --git a/doc/user_guide.rst b/doc/user_guide.rst deleted file mode 100644 index 801de87..0000000 --- a/doc/user_guide.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _user_guide: - -:octicon:`person` User Guide -============================ -