Skip to content

Commit ffd1bac

Browse files
tkiliastkilias
authored
#6: Translate README to rst and split up sections (#5)
* Translated Readme to rst and split into different section files * Shorten Readme and point from it to github pages
1 parent b4bd5b1 commit ffd1bac

16 files changed

+154
-119
lines changed

‎README.md

+3-75
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,7 @@
1-
<h1 align="center">Developer Documentation</h1>
1+
<h1 align="center">exasol/developer-documentation</h1>
22

33
<p align="center">
4-
Documentation and resources for data scientists and programmatic users to perform analytics with Exasol and to build applications on top.
4+
Documentation and resources for developing software and data science solutions and applications on top of the Exasol Analytics Engine.
55
</p>
66

7-
8-
# Getting Started
9-
There are three ways to get started with Exasol:
10-
- Download the [community edition](https://www.exasol.com/free-signup-community-edition/)
11-
- Use the [docker version](https://github.com/exasol/docker-db)
12-
- Signup for a free [SaaS trial](https://cloud.exasol.com/signup)
13-
14-
In the following we are going to use the SaaS version.
15-
16-
## Setting up the db
17-
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.
18-
## Installing pyexasol
19-
Once your database is up and running you can connect via any client. From Python we use [PyExasol](https://github.com/exasol/pyexasol).
20-
It can be easily installed via
21-
```
22-
pip install pyexasol[pandas]
23-
```
24-
25-
## Connecting to the db
26-
Connecting to an Exasol database is performed via:
27-
```python
28-
import pyexasol
29-
30-
C = pyexasol.connect(dsn='<host:port>', user='sys', password='exasol')
31-
```
32-
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):
33-
```python
34-
import pyexasol
35-
36-
C = pyexasol.connect(dsn='<host:port>', user='sys', password='<token>')
37-
```
38-
Finally you can also wrap all credentials into a [local config file](https://exasol.github.io/pyexasol/master/user_guide/local_config.html):
39-
```python
40-
C = pyexasol.connect_local_config('my_exasol')
41-
```
42-
## Executing SQL
43-
Running your first query is pretty straightforward:
44-
```python
45-
stmt = C.execute("SELECT * FROM EXA_ALL_USERS")
46-
47-
for row in stmt:
48-
print(row)
49-
```
50-
It also allows you to load resultsets into a pandas dataframe:
51-
```python
52-
C = pyexasol.connect(dsn='<host:port>', user='sys', password='exasol', compression=True)
53-
54-
df = C.export_to_pandas("SELECT * FROM EXA_ALL_USERS")
55-
print(df.head())
56-
```
57-
58-
59-
# Data Ingestion
60-
## CSV Files
61-
## Parquet Files
62-
## Import from external sources
63-
## HTTP Transport
64-
# Distributed Python (UDFs)
65-
## Intro to UDFs
66-
## Creating and running UDFs
67-
## Debugging UDFs
68-
# Advanced
69-
## move all the other stuff here
70-
# Examples
71-
# Environments
72-
## Jupyter Notebooks
73-
## VSCode
74-
## Positron
75-
# Integrations
76-
## JupySQL
77-
## Pandas
78-
## Ibis
79-
## SQLAlchemy
7+
Checkout the latest [documentation](https://exasol.github.io/developer-documentation/).

‎doc/api.rst

-5
This file was deleted.

‎doc/changes/unreleased.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33
## Features
44

55
* #1: Added initial Project Setup
6-
6+
* #4; Initial documentation version with outline and first fragments
7+
* #6: Translate README to rst and split up sections

‎doc/data_ingestion.rst

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Data Ingestion
2+
==============
3+
4+
CSV Files
5+
---------
6+
7+
Parquet Files
8+
-------------
9+
10+
Import from external sources
11+
----------------------------
12+
13+
HTTP Transport
14+
--------------

‎doc/developer_guide.rst

-5
This file was deleted.

‎doc/distributed_python/advanced.rst

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Advanced
2+
--------

‎doc/distributed_python/debugging.rst

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Debugging
2+
---------

‎doc/distributed_python/index.rst

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Distributed Python (UDFs)
2+
=========================
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
7+
intro
8+
usage
9+
debugging
10+
advanced

‎doc/distributed_python/intro.rst

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Intro to UDFs
2+
-------------

‎doc/distributed_python/usage.rst

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Creating and running UDFs
2+
-------------------------

‎doc/environments.rst

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Environments
2+
============
3+
4+
Jupyter Notebooks
5+
-----------------
6+
7+
VSCode
8+
------
9+
10+
Positron
11+
--------

‎doc/examples.rst

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Examples
2+
========

‎doc/getting_started.rst

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
2+
Getting Started
3+
===============
4+
5+
There are three ways to get started with Exasol:
6+
7+
- Download the `community
8+
edition <https://www.exasol.com/free-signup-community-edition/>`__
9+
- Use the `docker version <https://github.com/exasol/docker-db>`__
10+
- Signup for a free `SaaS trial <https://cloud.exasol.com/signup>`__
11+
12+
In the following we are going to use the SaaS version.
13+
14+
Setting up the db
15+
-----------------
16+
17+
Our `main
18+
documentation <https://docs.exasol.com/saas/get_started/saas_first_steps.htm>`__
19+
shows you how to create a SaaS account and setup your first database and
20+
cluster.
21+
22+
Installing pyexasol
23+
-------------------
24+
25+
Once your database is up and running you can connect via any client.
26+
From Python we use `PyExasol <https://github.com/exasol/pyexasol>`__. It
27+
can be easily installed via
28+
29+
::
30+
31+
pip install pyexasol[pandas]
32+
33+
Connecting to the db
34+
--------------------
35+
36+
Connecting to an Exasol database is performed via:
37+
38+
.. code:: python
39+
40+
import pyexasol
41+
42+
C = pyexasol.connect(dsn='<host:port>', user='sys', password='exasol')
43+
44+
It is slightly different when connecting to a SaaS database as we need a
45+
`personal access
46+
token <https://docs.exasol.com/saas/administration/access_mngt/access_token.htm>`__:
47+
48+
.. code:: python
49+
50+
import pyexasol
51+
52+
C = pyexasol.connect(dsn='<host:port>', user='sys', password='<token>')
53+
54+
Finally you can also wrap all credentials into a `local config
55+
file <https://exasol.github.io/pyexasol/master/user_guide/local_config.html>`__:
56+
57+
.. code:: python
58+
59+
C = pyexasol.connect_local_config('my_exasol')
60+
61+
Executing SQL
62+
-------------
63+
64+
Running your first query is pretty straightforward:
65+
66+
.. code:: python
67+
68+
stmt = C.execute("SELECT * FROM EXA_ALL_USERS")
69+
70+
for row in stmt:
71+
print(row)
72+
73+
It also allows you to load resultsets into a pandas dataframe:
74+
75+
.. code:: python
76+
77+
C = pyexasol.connect(dsn='<host:port>', user='sys', password='exasol', compression=True)
78+
79+
df = C.export_to_pandas("SELECT * FROM EXA_ALL_USERS")
80+
print(df.head())

‎doc/index.rst

+10-28
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,17 @@
1-
Documentation of exasol-developer-documentation
2-
------------------------------------------------
1+
=======================
2+
Developer Documentation
3+
=======================
34

4-
.. grid:: 1 1 3 2
5-
:gutter: 2
6-
:padding: 0
7-
:class-container: surface
8-
9-
.. grid-item-card:: :octicon:`person` User Guide
10-
:link: user_guide
11-
:link-type: ref
12-
13-
Resource for users to understand how to utilize this project and its features.
14-
15-
.. grid-item-card:: :octicon:`tools` Developer Guide
16-
:link: developer_guide
17-
:link-type: ref
18-
19-
Instructions and best practices to help developers contribute to the project and set up their development environment.
20-
21-
.. grid-item-card:: :octicon:`question` FAQ
22-
:link: faq
23-
:link-type: ref
24-
25-
Frequently asked questsions.
5+
Documentation and resources for data scientists and programmatic users to perform analytics with Exasol and to build applications on top.
266

277
.. toctree::
288
:maxdepth: 1
29-
:hidden:
309

31-
user_guide
32-
developer_guide
33-
api
10+
getting_started
11+
data_ingestion
12+
distributed_python/index.rst
13+
examples
14+
environments
15+
integrations
3416
faq
3517
changes/changelog

‎doc/integrations.rst

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Integrations
2+
============
3+
4+
JupySQL
5+
-------
6+
7+
Pandas
8+
------
9+
10+
Ibis
11+
----
12+
13+
SQLAlchemy
14+
----------

‎doc/user_guide.rst

-5
This file was deleted.

0 commit comments

Comments
 (0)