This commit is contained in:
Dave Shawley 2016-02-25 11:49:53 -05:00
commit 00676c8051
20 changed files with 317 additions and 0 deletions

7
.gitignore vendored Normal file
View file

@ -0,0 +1,7 @@
.DS_Store
*.pyc
build
dist
env
*.egg-info
.coverage

14
.travis.yml Normal file
View file

@ -0,0 +1,14 @@
language: python
python:
- 2.7
- 3.4
- 3.5
before_install:
- pip install nose coverage codecov
- pip install -r requires/testing.txt
install:
- pip install -e .
script: nosetests --with-coverage
after_success:
- codecov
sudo: false

25
LICENSE Normal file
View file

@ -0,0 +1,25 @@
Copyright (c) 2016 AWeber Communications
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of Sprockets nor the names of its contributors may be used to
endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

5
MANIFEST.in Normal file
View file

@ -0,0 +1,5 @@
include LICENSE
include tests.py
graft docs
graft examples
graft requires

3
README.rst Normal file
View file

@ -0,0 +1,3 @@
Amazon DynamoDB Connector
=========================
Connects an application to an Amazon DynamoDB instance.

4
docs/api.rst Normal file
View file

@ -0,0 +1,4 @@
API Documentation
=================
.. automodule:: sprockets.clients.dynamodb

44
docs/conf.py Normal file
View file

@ -0,0 +1,44 @@
# -*- coding: utf-8 -*-
import alabaster
from sprockets.clients import dynamodb
project = 'sprockets.clients.dynamodb'
copyright = 'AWeber Communications, Inc.'
version = dynamodb.__version__
release = '.'.join(str(v) for v in dynamodb.version_info[0:2])
needs_sphinx = '1.0'
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.viewcode',
]
templates_path = []
source_suffix = '.rst'
source_encoding = 'utf-8-sig'
master_doc = 'index'
exclude_patterns = []
pygments_style = 'sphinx'
html_theme = 'alabaster'
html_style = 'custom.css'
html_static_path = ['static']
html_theme_path = [alabaster.get_path()]
html_sidebars = {
'**': ['about.html', 'navigation.html'],
}
html_theme_options = {
'github_user': 'sprockets',
'github_repo': 'sprockets.clients.dynamodb',
'description': 'Amazon DynamoDB Connector',
'github_banner': True,
'travis_button': True,
'codecov_button': True,
'sidebar_width': '230px',
}
intersphinx_mapping = {
'python': ('http://docs.python.org/3/', None),
'tornado': ('http://tornadoweb.org/en/latest/', None),
'tornadoaws': ('https://tornado-aws.readthedocs.org/en/latest/', None),
}

111
docs/contributing.rst Normal file
View file

@ -0,0 +1,111 @@
How to Contribute
=================
Do you want to contribute fixes or improvements?
**AWesome!** *Thank you very much, and let's get started.*
Set up a development environment
--------------------------------
The first thing that you need is a development environment so that you can
run the test suite, update the documentation, and everything else that is
involved in contributing. The easiest way to do that is to create a virtual
environment for your endevours::
$ python3 -mvenv env
Don't worry about writing code against previous versions of Python unless
you you don't have a choice. That is why we run our tests through `tox`_.
If you don't have a choice, then install `virtualenv`_ to create the
environment instead. The next step is to install the development tools
that this project uses. These are listed in *requires/development.txt*::
$ env/bin/pip install -qr requires/development.txt
At this point, you will have everything that you need to develop at your
disposal. *setup.py* is the swiss-army knife in your development tool
chest. It provides the following commands:
**./setup.py nosetests**
Run the test suite using `nose`_ and generate a nice coverage report.
**./setup.py build_sphinx**
Generate the documentation using `sphinx`_.
**./setup.py flake8**
Run `flake8`_ over the code and report style violations.
If any of the preceding commands give you problems, then you will have to
fix them **before** your pull request will be accepted.
Running Tests
-------------
The easiest (and quickest) way to run the test suite is to use the
*nosetests* command. It will run the test suite against the currently
installed python version and report not only the test result but the
test coverage as well::
$ ./setup.py nosetests
running nosetests
running egg_info
writing dependency_links to sprockets.clients.dynamodb.egg-info/dependency_links.txt
writing top-level names to sprockets.clients.dynamodb.egg-info/top_level.txt
writing sprockets.clients.dynamodb.egg-info/PKG-INFO
reading manifest file 'sprockets.clients.dynamodb.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
warning: no previously-included files matching '__pycache__'...
warning: no previously-included files matching '*.swp' found ...
writing manifest file 'sprockets.clients.dynamodb.egg-info/SOURCES.txt'
...
Name Stmts Miss Branch BrMiss Cover Missing
----------------------------------------------------------------------
...
----------------------------------------------------------------------
TOTAL 95 2 59 2 97%
----------------------------------------------------------------------
Ran 44 tests in 0.054s
OK
That's the quick way to run tests. The slightly longer way is to run
the `tox`_ utility. It will run the test suite against all of the
supported python versions in parallel. This is essentially what Travis-CI
will do when you issue a pull request anyway::
$ env/bin/tox
py27 recreate: /.../sprockets.clients.dynamodb/build/tox/py27
GLOB sdist-make: /.../sprockets.clients.dynamodb/setup.py
py34 recreate: /.../sprockets.clients.dynamodb/build/tox/py34
py27 installdeps: -rtest-requirements.txt, mock
py34 installdeps: -rtest-requirements.txt
py27 inst: /.../sprockets.clients.dynamodb/build/tox/dist/sprockets.clients.dynamodb-0.0.0.zip
py27 runtests: PYTHONHASHSEED='2156646470'
py27 runtests: commands[0] | /../sprockets.clients.dynamodb/build/tox/py27/bin/nosetests
py34 inst: /../sprockets.clients.dynamodb/.build/tox/dist/sprockets.clients.dynamodb-0.0.0.zip
py34 runtests: PYTHONHASHSEED='2156646470'
py34 runtests: commands[0] | /.../sprockets.clients.dynamodb/build/tox/py34/bin/nosetests
_________________________________ summary _________________________________
py27: commands succeeded
py34: commands succeeded
congratulations :)
This is what you want to see. Now you can make your modifications and keep
the tests passing.
Submitting a Pull Request
-------------------------
Once you have made your modifications, gotten all of the tests to pass,
and added any necessary documentation, it is time to contribute back for
posterity. You've probably already cloned this repository and created a
new branch. If you haven't, then checkout what you have as a branch and
roll back *master* to where you found it. Then push your repository up
to github and issue a pull request. Describe your changes in the request,
if Travis isn't too annoyed someone will review it, and eventually merge
it back.
.. _flake8: http://flake8.readthedocs.org/
.. _nose: http://nose.readthedocs.org/
.. _sphinx: http://sphinx-doc.org/
.. _tox: http://testrun.org/tox/
.. _virtualenv: http://virtualenv.pypa.io/

9
docs/history.rst Normal file
View file

@ -0,0 +1,9 @@
.. :changelog:
Release History
===============
`Next Release`_
---------------
.. _Next Release: https://github.com/sprockets/sprockets.clients.dynamodb/compare/0.0.0...master

8
docs/index.rst Normal file
View file

@ -0,0 +1,8 @@
.. include:: ../README.rst
.. toctree::
:hidden:
api
contributing
history

4
docs/static/custom.css vendored Normal file
View file

@ -0,0 +1,4 @@
@import url("alabaster.css");
h1.logo {
font-size: 12pt;
}

4
requires/development.txt Normal file
View file

@ -0,0 +1,4 @@
-e .
-r testing.txt
flake8>=2.5,<3
Sphinx>=1.3,<2

View file

@ -0,0 +1,2 @@
tornado-aws>=0.4,<0.5
tornado>=4.0

2
requires/testing.txt Normal file
View file

@ -0,0 +1,2 @@
nose>=1.3.7,<2
coverage>=3.7,<4

13
setup.cfg Normal file
View file

@ -0,0 +1,13 @@
[bdist_wheel]
universal = 1
[build_sphinx]
all-files = 1
[flake8]
exclude = env,build
[nosetests]
cover-branches = 1
cover-erase = 1
cover-package = sprockets.clients.dynamodb

58
setup.py Executable file
View file

@ -0,0 +1,58 @@
#!/usr/bin/env python
#
import os.path
import setuptools
from sprockets.clients import dynamodb
def read_requirements(filename):
requirements = []
try:
with open(os.path.join('requires', filename)) as req_file:
for line in req_file:
if '#' in line:
line = line[:line.index('#')]
line = line.strip()
if line.startswith('-r'):
requirements.extend(read_requirements(line[2:].strip()))
elif line:
requirements.append(line)
except IOError:
pass
return requirements
setuptools.setup(
name='sprockets.clients.dynamodb',
version=dynamodb.__version__,
description='DynamoDB connector',
author='AWeber Communications',
author_email='api@aweber.com',
url='https://github.com/sprockets/sprockets.clients.dynamodb',
install_requires=read_requirements('installation.txt'),
license='BSD',
namespace_packages=['sprockets', 'sprockets.clients'],
packages=setuptools.find_packages(),
classifiers=[
'Development Status :: 1 - Planning',
'Environment :: No Input/Output (Daemon)',
'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
'Natural Language :: English',
'Operating System :: OS Independent',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: Implementation :: CPython',
'Programming Language :: Python :: Implementation :: PyPy',
'Topic :: Software Development :: Libraries',
'Topic :: Software Development :: Libraries :: Python Modules'],
test_suite='nose.collector',
tests_require=read_requirements('testing.txt'),
zip_safe=True,
)

1
sprockets/__init__.py Normal file
View file

@ -0,0 +1 @@
__import__('pkg_resources').declare_namespace(__name__)

View file

@ -0,0 +1 @@
__import__('pkg_resources').declare_namespace(__name__)

View file

@ -0,0 +1,2 @@
version_info = (0, 0, 0)
__version__ = '.'.join(str(v) for v in version_info)

0
tests.py Normal file
View file