Merge pull request #1 from aws-samples/samples-v1.0.0-rc.1

Upload the initial release of the QLDB Python Sample Application.

Author: othonrsanchez

.gitignore

@@ -0,0 +1,19 @@
+*~
+*#
+*.swp
+*.DS_STORE
+
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+
+/.coverage
+/.coverage.*
+/.cache
+/.pytest_cache
+/.idea/
+
+/docs/build
+/build
+/dist

CONTRIBUTING.md

@@ -1,15 +1,15 @@
 Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+SPDX-License-Identifier: MIT-0
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this
+software and associated documentation files (the "Software"), to deal in the Software
+without restriction, including without limitation the rights to use, copy, modify,
+erge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so.
 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+NCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LICENSE

@@ -1,13 +1,73 @@
-## My Project
+# AmazonQLDB Samples
 
-TODO: Fill this README out!
+The samples in this project demonstrate several uses of Amazon Quantum Ledger Database (QLDB).
 
-Be sure to:
+## Requirements
 
-* Change the title in this README
-* Edit your repository description on GitHub
+### Basic Configuration
 
-## License
+You need to set up your AWS security credentials and config before the sample code is able
+to connect to AWS. 
+
+Set up credentials (in e.g. `~/.aws/credentials`):
+
+```
+[default]
+aws_access_key_id = <your access key id>
+aws_secret_access_key = <your secret key>
+```
+
+Set up a default region (in e.g. `~/.aws/config`):
+
+```
+[default]
+region = us-east-1 <or other region>
+```
+
+See [Accessing Amazon QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/accessing.html#SettingUp.Q.GetCredentials) page for more information.
+
+
+### Python 3.x
+
+The examples require Python 3.x. Please see the link below for more detail to install Python 3.x:
+
+* [Python 3.x Installation](https://www.python.org/downloads/)
+
+## Installing the driver and dependencies
+
+Install Python QLDB driver and other dependencies using pip:
 
-This library is licensed under the MIT-0 License. See the LICENSE file.
+```
+pip install -r requirements.txt
+```
+
+## Running the Sample code
+
+The sample code creates a ledger with tables and indexes, and inserts some documents into those tables,
+among other things. Each of the examples in this project can be run in the following way:
+
+```python
+python create_ledger.py
+```
+
+The above example will build the CreateLedger class with the necessary dependencies and create a ledger named:
+`vehicle-registration`. You may run other examples after creating a ledger.
+
+## Documentation
+
+Sphinx is used for documentation. You can generate HTML locally with the following:
+
+```
+$ pip install -r requirements-docs.txt
+$ pip install -e .
+$ cd docs
+$ make html
+```
+
+### Release 1.0.0-rc.1 (October 28, 2019)
+
+* Initial preview release of the QLDB Python Sample Application.
+
+## License
 
+This library is licensed under the MIT-0 License.