Metadata-Version: 2.1
Name: netapp-api
Version: 1.0.5
Summary: NetApp OCUM API wrapper
Home-page: https://github.com/cerndb/netapp-api-python
Author: CERN
Author-email: albin.stjerna@cern.ch
Maintainer: Borja Aparicio Cotarelo
Maintainer-email: borja.aparicio.cotarelo@cern.ch
License: GPLv3
Description: [![Build Status](https://travis-ci.org/cerndb/netapp-api-python.svg?branch=master)](https://travis-ci.org/cerndb/netapp-api-python)
        [![Coverage Status](https://coveralls.io/repos/github/cerndb/netapp-api-python/badge.svg?branch=master)](https://coveralls.io/github/cerndb/netapp-api-python?branch=master)
        
        ## About
        This is a human-made Python implementation of relevant parts of NetApp's
        ZAPI.
        
        ### Supported Systems
        
        Currently, only DFM 6.3/6.4 and ONTAP is supported.
        
        ### Implemented Features
        
        DFM:
        - Events (just reading)
        
        ONTAP:
        - Volumes (reading)
        - Snapshots (reading)
        - Locks (reading)
        
        ## Examples
        
        Connect to a server:
        
        ``` python
        
        s = Server(hostname="netapp-1234", username="admin",
                   password="admin123")
        
        ```
        
        Get a secific event:
        
        ``` python
        event = s.events.single_by_id(13)
        ``` 
        
        Filter events:
        
        
        ``` python
        for event in s.events.filter(greater_than_id=13):
            print(event)
        ```
        
        Pagination is automatically handled via Python generators:
        
        ``` python
        for event in s.events.filter(max_records=4):
                print(event)
                # Will perform multiple queries under the hood
        ```
        
        ## Setup
        
        1. `mkvirtualenv netapp-api-python`
        2. `workon netapp-api-python`
        3. `pip install -r requirements.txt`
        4. `python setup.py develop`
        
        
        ## Testing
        
        Set the environment variables to a host running NetApp OCUM
        `NETAPP_HOST`, `NETAPP_USERNAME`, and `NETAPP_PASSWORD` and run
        `pytest`. To test ONTAP set `ONTAP_HOST`, etc.
        
        Offline tests are enabled using Betamax, which records test data from
        interaction with the servers and stores it in the cassettes
        directory. One "cassette" is generated per test.
        
        ## Generating documentation
        
        Documentation via Sphinx is available (more or less). You can generate
        HTML documentation by going to /doc/ and entering `make html`.
        
        The generated documentation is
        [available on GitHub pages](https://cerndb.github.io/netapp-api-python/).
        
        ## License
        
        Licence version 3 (GPL Version 3), copied verbatim in the file "LICENSE".
        In applying this license, CERN does not waive the privileges and immunities
        granted to it by virtue of its status as Intergovernmental Organization
        or submit itself to any jurisdiction.
        
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
