diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c419da0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,29 @@ +BSD 3-Clause License + +Copyright (c) 2020, Polymathian +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. 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. + +3. Neither the name of the copyright holder 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. \ No newline at end of file diff --git a/README.md b/README.md index 54b22ba..4e13c21 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,20 @@ Python watchdog to sync file changes to AWS S3 -Requires Python 3.5+ +Requires Python 3.6+ ## Usage +Install from [PyPI](https://pypi.org/project/sharpei/) + +```bash +pip install sharpei +``` + #### CLI ```bash # Monitor the current directory and send all files > sharpei . s3://bucket/key-prefix/ ``` + +Use `sharpei --help` to discover additional options diff --git a/setup.py b/setup.py index 9368816..dcfe15f 100644 --- a/setup.py +++ b/setup.py @@ -26,6 +26,7 @@ def get_version(): version=get_version(), description='Watchdog to sync file changes to AWS S3', long_description=open('README.md').read(), + long_description_content_type="text/markdown", author='Polymathian', url='https://github.com/polymathian/sharpei', packages=find_packages(exclude=['test*']), @@ -36,6 +37,7 @@ def get_version(): 'sharpei = sharpei.cli:main' ] }, + python_requires='>=3.6', license="Apache License 2.0", classifiers=[ 'Development Status :: 3 - Alpha', @@ -43,7 +45,6 @@ def get_version(): 'Natural Language :: English', 'Programming Language :: Python', 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', diff --git a/sharpei/__init__.py b/sharpei/__init__.py index 3d6c046..1ccf01b 100644 --- a/sharpei/__init__.py +++ b/sharpei/__init__.py @@ -1,2 +1,2 @@ __author__ = "Polymathian" -__version__ = "0.1.0" +__version__ = "0.1.1"