Skip to content

Commit 1ec3db5

Browse files
author
csplinter
authored
Update README.md
1 parent 16a5043 commit 1ec3db5

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
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
44
simple example of how to connect to and query DataStax Apollo databases.
55

6+
Contributor(s): [Chris Splinter](https://github.com/csplinter)
7+
8+
## Objectives
9+
- 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+
613
## Project Layout
714
- [getting_started_with_apollo.py](getting_started_with_apollo.py) - entrypoint for the backend, registers controller blueprints with Flask app
815
- [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
1219
- [dao](dao/) - methods for accessing the database, contains the DataStax Driver API calls
1320
- [controller](controller/) - defines the API endpoints using Flask decorators
1421

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.
1626

27+
## Setup & Running
28+
29+
### Setup
1730
If you are familiar with Python, then you've likely gotten your hands on Python virtual environments.
1831
We'll be leveraging pyenv while setting up this backend, which will serve our
1932
Spacecraft frontend that will have you flying through the stars.
@@ -46,10 +59,11 @@ pip install Flask flask-cors cassandra-driver
4659

4760
Last one, clone this repo
4861
```
49-
git clone https://github.com/csplinter/getting-started-with-apollo-python.git
62+
git clone https://github.com/DataStax-Examples
63+
/getting-started-with-apollo-python.git
5064
```
5165

52-
## Running
66+
### Running
5367

5468
If everything above went smoothly, fingers crossed, then we are ready to rock.
5569
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
7286
* Debugger is active!
7387
* Debugger PIN: 204-527-831
7488
```
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

Comments
 (0)