Metadata-Version: 1.1
Name: smstrade
Version: 0.2.1
Summary: a Python library and command line tool to send SMS via the smstrade service.
Home-page: https://gitorious.org/python-smstrade
Author: Jan Dittberner
Author-email: jan@dittberner.info
License: MIT
Description: About smstrade
        ==============
        
        Smstrade is a `Python <http://www.python.org/>`_ library that can be used to
        send SMS via the service of `smstrade.eu <http://www.smstrade.eu>`_.
        
        The http(s) API is documented at
        http://www.smstrade.eu/pdf/SMS-Gateway_HTTP_API_v2_en.pdf.
        
        Installation
        ------------
        
        You can either install smstrade from the `Python Package Index`_ PyPI or from
        the `Git repository`_.
        
        To install from PyPI you may use `pip`_::
        
            pip install smstrade
        
        To install from Git you need to clone the repository and run setup.py::
        
            git clone https://git.gitorious.org/python-smstrade/python-smstrade.git
            cd python-smstrade
            python setup.py develop
        
        .. note:: Be aware that you need write access to you Python installation to
            perform the last step above. You may also use a `virtualenv`_ environment
            to run a sandboxed version of smstrade.
        
        .. _Python Package Index: https://pypi.python.org/pypi/smstrade/
        .. _Git Repository: https://gitorious.org/python-smstrade/python-smstrade
        .. _pip: https://pypi.python.org/pypi/pip/
        .. _virtualenv: https://pypi.python.org/pypi/virtualenv/
        
        Usage
        -----
        
        Sending SMS
        ...........
        
        You may either use the API for SMS sending::
        
            import smstrade
        
            api = smstrade.SMSTrade()
            api.key = 'yourkey'
            api.send_sms(['00491701234567'], 'Test message')
        
        or do the same with the command line tool::
        
            smstrade_send --key yourkey 00491701234567 'Test message'
        
        You get help for the command line tool by running::
        
            smstrade_send -h
        
        .. note::
        
            You can place all the configuration values into an ini file. See
            examples/smstrade.ini for an example. Before you really send SMS messages
            you need to put ``debug = False`` in your smstrade.ini.
        
            The file smstrade.ini is searched in system dependent paths as well as in
            the current directory. The search path is printed when invoking
            :literal:`smstrade_send -h` together with the description of the
            ``--config`` parameter.
        
            The smstrade.ini file is shared with the smstrade_balance tool.
        
        Getting the account balance
        ...........................
        
        Use the API for getting your account balance::
        
            import smstrade
        
            api = smstrade.SMSTradeBalanceAPI()
            api.key = 'yourkey'
            balance = api.get_balance()
        
        or do the same with the command line tool::
        
            smstrade_balance --key yourkey
        
        
        License
        =======
        
        Copyright (c) 2014 Jan Dittberner
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
        
        
        Changes
        =======
        
        Release 0.2.1 (2014-02-21)
        ------------------------
        
        * fix typo, use dlr instead of dir
        * improve tests
        
        Release 0.2 (2014-02-20)
        ------------------------
        
        * add support for account balance request
        
        Release 0.1 (2014-02-20)
        ------------------------
        
        * Initial release
        * support for the SMS sending API documented in
          http://www.smstrade.eu/pdf/SMS-Gateway_HTTP_API_v2_en.pdf
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Communications
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires: requests
Requires: appdirs
