Metadata-Version: 1.1
Name: citylink-utils
Version: 0.8
Summary: Simple utility package to handle CityLink dispatches for commercial customers
Home-page: https://github.com/OdinsHat/citylink-utils
Author: Doug Bromley
Author-email: doug+clutils@tintophat.com
License: BSD
Description: CityLink Utilities
        ==================
        
        The following package was developed to help process despatch requests
        with `City Link`_ couriers based in the UK.
        
        They lacked an API for easy management of various functions such as
        retrieving manifests, reference codes, etc.
        
        This package works by using the Mechanize library to navigate your
        commercial account admin area to carry out requests such as:
        
        -  Fetch pending collections
        -  Grab company reference numbers
        -  Grab CityLink reference numbers
        -  Get full HTML copy of collection manifest
        -  Email the manifest
        
        Requirements
        ------------
        
        The version below have been tested and working. Its possible other
        earlier and later versions may work. \* `Mechanize 0.2.5+`_ \* `lxml
        3.3.3+`_ \* `Mailer 0.7+`_
        
        Examples
        --------
        
        Email Manifest
        ~~~~~~~~~~~~~~
        
        .. code:: python
        
            import citylink.CityLink
        
            userid = "XXXXXX"
            password = "XXXXXX"
        
            cl = CityLink(userid, password)
            cl.login()
            cl.mail_manifest(emailfrom="from@test.com", emailto="to@test.com")
        
        Get list of CityLink reference codes
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: python
        
            import citylink.CityLink
        
            userid = "XXXXXX"
            password = "XXXXXX"
        
            cl = CityLink(userid, password)
            cl.login()
            print(cl.fetch_citylink_refs())
        
        .. _City Link: https://www.city-link.co.uk/
        .. _Mechanize 0.2.5+: https://pypi.python.org/pypi/mechanize/
        .. _lxml 3.3.3+: https://pypi.python.org/pypi/lxml
        .. _Mailer 0.7+: https://pypi.python.org/pypi/mailer
Keywords: citylink courier web scraping
Platform: any
Classifier: License :: OSI Approved :: BSD License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing :: Markup :: HTML
