Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Truong Le committed May 13, 2018
1 parent 607f3e1 commit 6d35498
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 30 deletions.
28 changes: 0 additions & 28 deletions README.md

This file was deleted.

33 changes: 33 additions & 0 deletions README.rst
@@ -0,0 +1,33 @@
export_dynamodb
===============

A cli to export dynamodb.

* [Key Features](key-features)
* [How to use](#how-to-use)
* [Getting started](#getting-started)

Key Features
============
* Scan table in single or parallel thread.
* Output file can be json or csv.
* Get list of tables from yaml file.

How to use
==========

Getting started
---------------

.. code:: bash
# Install virtual environment
$ pip3 install virtualenv
$ virtualenv -p python3 venv
$ source venv/bin/activate
# Install dependencies
$ pip install -r requirements.txt
# if you want to exit from development environment, use deactivate command
$ deactivate
9 changes: 9 additions & 0 deletions export-dynamodb/main.py
@@ -0,0 +1,9 @@
import click

@click.command()
@click.option('--table', help='Name of table to export.')
def main(table):
print('Dynamodb: {}'.format(table))

if __name__ == '__main__':
main()
9 changes: 7 additions & 2 deletions setup.py
@@ -1,14 +1,15 @@
from distutils.core import setup

setup(
name = 'export-dynamodb',
packages = ['export-dynamodb'],
version = '1.0.0',
version = '1.0.1',
description = 'A cli to export Amazon DynamoDb',
author = 'Truong Le',
author_email = 'travistrle@gmail.com',
url = 'https://github.com/travistrle/export-dynamodb.git',
license = 'GPLv3',
download_url = 'https://github.com/travistrle/export-dynamodb/archive/1.0.0.tar.gz',
download_url = 'https://github.com/travistrle/export-dynamodb/archive/1.0.1.tar.gz',
keywords = ['aws', 'dynamodb', 'export'],
classifiers = [
'Development Status :: 3 - Alpha',
Expand All @@ -17,4 +18,8 @@
'Programming Language :: Python :: 3.6',
],
python_requires='>=3.6',
install_requires=[
'click==6.7',
'boto3==1.7.19'
],
)

0 comments on commit 6d35498

Please sign in to comment.