Metadata-Version: 2.1
Name: pystackpath
Version: 0.0.2
Summary: A package to interact with StackPath
Home-page: https://github.com/NCCloud/pystackpath
Author: Sandro Modarelli
Author-email: sandro.modarelli@namecheap.com
License: UNKNOWN
Description: # PyStackpath
        
        Python library interact with StackPath API (https://developer.stackpath.com/en/)
        
        It uses a custom OAuth2 requests.session
        
        ## Install
        
        ```bash
        pip install pystackpath
        ```
        
        ## Examples
        
        ### Set up a new Stackpath instance
        ```python
        from pystackpack import Stackpath
        
        sp = Stackpath(
            os.getenv("STACKPATH_CLIENTID"),
            os.getenv("STACKPATH_APISECRET")
        )
        ```
        
        ###  Search for stacks
        ```python
        stacks = sp.stacks().index(filter="name='my-awesome-stack' and status='ACTIVE'")
        print(stacks)
        ```
        
        ### Get one stack
        ```python
        stackid = "afcdaf14-47cb-40dd-9c13-3b20e6caf74a
        onestack = sd.stacks().get(stackid)
        ```
        
        ### Create a new stack
        ```python
        accountid = "081af5ee-38f8-44e9-b08a-881ea5de66f9"
        newstack = sp.stacks().create(accountid, "my-second-stack")
        ```
        
        ### Create a cdn site
        ```python
        stackid = "afcdaf14-47cb-40dd-9c13-3b20e6caf74a
        cdnsite = sd.stacks().get(stackid).cdnsites().create("cdn.johndoe.com", "www.johndoe.com")
        ```
        
        ### Search for cdn sites
        ```python
        cdnsite = sd.stacks().get(stackid).cdnsites().index(
            filter="label='www.johndoe.com' and status='ACTIVE'"
        )
        ```
        
        ### Delete a cdn site
        ```python
        cdnsiteid = "19e1a7b2-068f-491c-a95f-b64eae66dd34"
        cdnsite = sd.stacks().get(stackid).cdnsites().get(cdnsiteid).delete()
        ```
        
        ### Purge a cdn resource
        ```python
        purge_result1 = sd.stacks().get(stackid).cdnsites().purge(
            url="https://example.com/resource/",
        )
        
        ## Function accepts the arguments shown below with their respective
        ## default values. See API Doc for more information on options:
        ## https://developer.stackpath.com/en/api/cdn/#operation/PurgeContent
        purge_result2 = sd.stacks().get(stackid).cdnsites().purge(
            url="https://example.com/",
            recursive = True,
            invalidateOnly = False,
            purgeAllDynamic = False,
            headers = [],
            purgeSelector = []
        )
        ```
        
Keywords: stackpath,cdn,waf,proxy,kubernetes
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/markdown
