diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..78d8ee2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) 2020, Kumi Systems e.U. + +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. + +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 OWNER 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. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..c1a7121 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +include LICENSE +include README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..48a8e0e --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# pykumisms + +A class to interact with KumiSMS. + +## Quick start + +1. Import `kumisms` into your project + + ```python + import kumisms + ``` + +2. Create a KumiSMS object with your API key + + ```python + gateway = KumiSMS("my_api_key") + ``` + +3. Start making requests + + ```python + gateway.send("+123456789", "Hello!") + ``` \ No newline at end of file diff --git a/__init__.py b/kumisms/__init__.py similarity index 100% rename from __init__.py rename to kumisms/__init__.py diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..613c63f --- /dev/null +++ b/setup.cfg @@ -0,0 +1,20 @@ +[metadata] +name = kumisms +version = 0.1 +description = Class to interact with KumiSMS +long_description = file: README.md +url = https://kumig.it/kumisystems/pykumisms +author = Kumi Systems e.U. +author_email = support@kumi.systems +license = BSD-2-Clause +classifiers = + Environment :: Web Environment + Intended Audience :: Developers + License :: OSI Approved :: BSD License + Operating System :: OS Independent + Programming Language :: Python + Programming Language :: Python :: 3 + Programming Language :: Python :: 3 :: Only + Programming Language :: Python :: 3.6 + Programming Language :: Python :: 3.7 + Programming Language :: Python :: 3.8 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..6068493 --- /dev/null +++ b/setup.py @@ -0,0 +1,3 @@ +from setuptools import setup + +setup()