Enhance the project.

.bumpversion.cfg

@@ -0,0 +1,13 @@
+[bumpversion]
+commit = True
+tag = False
+current_version = 0.1.0
+parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z]+))?
+serialize = 
+	{major}.{minor}.{patch}-{release}
+	{major}.{minor}.{patch}
+
+[bumpversion:file:kcpy/__init__.py]
+
+[bumpversion:file:VERSION]
+

.gitignore

@@ -115,3 +115,5 @@ erl_crash.dump
 *.db
 Documentation/
 .cache/
+
+.pytest_cache/

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Hengfeng Li
+Copyright (c) 2018 Hengfeng Li
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -0,0 +1,30 @@
+PYTHON ?= python
+GIT ?= git
+
+clean: clean-pyc clean-build
+
+clean-dist: clean clean-git-force
+
+clean-build:
+	rm -rf build/ dist/ .eggs/ *.egg-info/ .tox/ .coverage cover/
+
+clean-pyc:
+	-find . -type f -a \( -name "*.pyc" -o -name "*$$py.class" \) | xargs rm
+	-find . -type d -name "__pycache__" | xargs rm -r
+
+clean-git:
+	$(GIT) clean -xdn
+
+clean-git-force:
+	$(GIT) clean -xdf
+
+test:
+	pytest tests/tests.py
+
+build:
+	$(PYTHON) setup.py sdist bdist_wheel
+
+dist: clean-dist build
+
+lint:
+	flake8

Pipfile

@@ -1,17 +1,14 @@
 [[source]]
-
 url = "https://pypi.python.org/simple"
 verify_ssl = true
 name = "pypi"
 
-
 [packages]
-
 "boto3" = "*"
 
-
 [dev-packages]
-
-moto = "*"
 pytest = "*"
 faker = "*"
+bumpversion = "*"
+"flake8" = "*"
+moto = "*"

README.md

@@ -2,13 +2,19 @@
 
 A kinesis consumer is purely written in python. 
 
-# Features
+## Features
 
 * Read records from a stream with multiple shards
 
-# Todo
+## Todo
 
 * Open a consumer when adding a new shard
 * Close a consumer when shutting down an existing shard
 * Save checkpoint for each shard
 * Allow kcpy to run on multiple machines
+
+## Changelog
+
+### 0.1.0
+
+* First version of kcpy.  

VERSION

@@ -0,0 +1 @@
+0.1.0

kcpy/__init__.py

@@ -0,0 +1,6 @@
+__title__ = 'kcpy'
+__version__ = '0.1.0'
+__author__ = 'Hengfeng Li'
+__license__ = 'MIT 2018'
+
+from .core import *

setup.cfg

@@ -0,0 +1,8 @@
+[bdist_wheel]
+universal = 1
+
+[flake8]
+ignore = E226,E302,E41,F401,E402,F403
+max-line-length = 120
+exclude = tests/*,.eggs/*
+max-complexity = 10

setup.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+
+import kcpy
+
+from setuptools import setup, find_packages
+
+setup(
+    name='kcpy',
+    version=kcpy.__version__,
+    description='A kinesis consumer is purely written in python.',
+    author='Hengfeng Li',
+    author_email='[email protected]',
+    license='MIT License',
+
+    packages=find_packages(),
+    package_dir={'kcpy': 'kcpy'},
+    include_package_data=True,
+    python_requires='>=3.5.0',
+    keywords=[
+        'kinesis',
+        'consumer',
+        'stream',
+        'processing',
+        'queue',
+    ],
+    scripts=[],
+    install_requires=[
+        'boto3',
+    ],
+    dependency_links=[],
+    tests_require=[
+        'pytest',
+        'moto',
+        'faker',
+    ],
+    zip_safe=False,
+)