Metadata-Version: 1.0
Name: opensrscli
Version: 0.1.0
Summary: A CLI for OpenSRS reseller accounts
Home-page: http://pypi.python.org/opensrscli
Author: Shawn Siefkas
Author-email: shawn.siefkas@meredith.com
License: BSD
Description: README
        ======
        
        **DISCLAIMER: This is extremely alpha/beta/not-production code at this point.  I take no
        responsiblity for the use of this software to manage OpenSRS accounts.**
        
        This package provides a set of `pyCLI`_ applications for interfacing with an `OpenSRS`_
        reseller account.
        
        .. _pyCLI: http://packages.python.org/pyCLI/
        .. _OpenSRS: http://www.opensrs.com/
        
        Installation
        ------------
        
        I haven't put this on pypi yet so install from github for the time being::
        
         $ pip install opensrscli
        
        Configuration
        -------------
        
        Basic Auth
        ~~~~~~~~~~
        
        You must create a yaml file to provide OpenSRS authentication info at a 
        minimum. This should match the user and private key information you setup in
        the OpenSRS reseller dashboard for API access.
        
        Auth template::
        
         username:
         private_key:
        
        Now provide the prefs.yaml file to opensrs commands with the -p or
        --preferences parameter.  If no preferences file is specified opensrs-cli will
        look in `$HOME/.opensrs/prefs`.
        
        Contact Sets
        ~~~~~~~~~~~~
        
        In order to perform and domain registration or transfers contact sets will need
        to be defined.  Add them to prefs.yaml using the following template.  A default
        contact can be provided and fields can be overriden for admin, owner, billing,
        or tech contacts.
        
        Contact set template::
        
          contact_set:
            default:
              first_name:
              last_name:
              org_name:
              address1:
              city:
              state:
              postal_code:
              country:
              phone:
              email:
            billing:
              last_name:
              email:
            tech:
              last_name:
              email:
        
        Usage
        -----
        
        This package installs scripts prefixed with opensrs.
        
        Currently provided:
        
        - opensrs-balance
        - opensrs-check-transfer
        - opensrs-transfer
        
Keywords: opensrs
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: BSD License
