You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-3Lines changed: 19 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,13 @@
3
3
This sample Python backend provides a REST API service that is used with the [Getting Started with Apollo UI](https://github.com/DataStax-Examples/getting-started-with-apollo-ui) to show a
4
4
simple example of how to connect to and query DataStax Apollo databases.
- How to connect to DataStax Apollo using the secure connect bundle
10
+
- How to share a DataStax Driver Session throughout a Python application
11
+
- How to expose a basic REST API using the DataStax Driver
12
+
6
13
## Project Layout
7
14
-[getting_started_with_apollo.py](getting_started_with_apollo.py) - entrypoint for the backend, registers controller blueprints with Flask app
8
15
-[schema.cql](schema.cql) - database schema used by the application
@@ -12,8 +19,14 @@ Note how this and [session_manager.py](dao/session_manager.py) are used to share
12
19
-[dao](dao/) - methods for accessing the database, contains the DataStax Driver API calls
13
20
-[controller](controller/) - defines the API endpoints using Flask decorators
14
21
15
-
## Setup
22
+
## How this works
23
+
This project is built in Python and uses Flask to expose a REST API backend for use with the [Getting Started with Apollo UI](https://github.com/DataStax-Examples/getting-started-with-apollo-ui).
24
+
25
+
This application is the middle man that receives requests from the UI web page and serves data from the underlying DataStax Apollo database.
16
26
27
+
## Setup & Running
28
+
29
+
### Setup
17
30
If you are familiar with Python, then you've likely gotten your hands on Python virtual environments.
18
31
We'll be leveraging pyenv while setting up this backend, which will serve our
19
32
Spacecraft frontend that will have you flying through the stars.
If everything above went smoothly, fingers crossed, then we are ready to rock.
55
69
Go to the directory that you just cloned this repo into
@@ -72,3 +86,5 @@ You should be met with the following output, note that it's running on `localhos
72
86
* Debugger is active!
73
87
* Debugger PIN: 204-527-831
74
88
```
89
+
90
+
Once the backend is running, you can start the [Getting Started with Apollo UI](https://github.com/DataStax-Examples/getting-started-with-apollo-ui) in order to use a web page that leverages this backend.
0 commit comments