Package: cookiesapi
Cookies SDK for PythonLibrary Version:1.0.0(beta)API Version:v1(stable)This repository defines an API client for easy access toCookiesAPIs from Python.InstallationFrom your favorite command line:pip install cookiesapiDocsGuides, access docs, and other resources can be found at theCookies API Console. Check there first if you can't find what you're after.API ReferenceBrandsStoresStrainsClass ReferenceAPI Client: Info about the main API client facade.HTTP Request: HTTP request object.HTTP Response: HTTP response object.Utility classes: General utilitiesDevops ReportsCoverage ReportInitialize the API ClientNote:Documentation for the client can be foundhere.The following parameters are configurable for the API Client:ParameterTypeDescriptionapikeystringConsumer API key issued by Cookies.environmentEnvironmentThe API environment.Default:Environment.SANDBOXtimeoutfloatThe value to use for connection timeout.Default: 60max_retriesintThe number of times to retry an endpoint call if it fails.Default: 0backoff_factorfloatA backoff factor to apply between attempts after the second try.Default: 2retry_statusesArray of intThe http statuses on which retry is to be done.Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]retry_methodsArray of stringThe http methods on which retry is to be done.Default: ['GET', 'PUT']The API client can be initialized as follows:fromcookiesapiimportCookiesSDKfromcookiesapi.configurationimportEnvironmentclient=CookiesSDK(apikey='apikey',environment=Environment.SANDBOX)The API key is also settable via theenvironment variableCOOKIES_APIKEY. If both are made available to the SDK at runtime, the constructor parameter wins.Obtaining CredentialsAuthorization for most Cookies APIs occurs via regular consumer API keys, which authorize the bearer to perform a broad set of operations (i.e. keys are usually API- or consumer-wide). To acquire authorized API credentials, visit theAPI Console.Sensitive APIs are gated by allowlists and may require additional security measures such as Mutual TLS (mTLS), OAuth 2, or asymmetric cryptographic signatures.EnvironmentsThe SDK can be configured to use a different environment for making API calls. Available environments are:FieldsNameDescriptionproductionProduction data and hosting environment.sandboxDefaultTesting and development environment.Please switch toproductiononly for production traffic. Otherwise, the two environments are identical, because they pull from a mirrored (albeit isolated) data source.ResourcesResources available for the Python SDK includeguides,reference docs, and theAPI Consolewhich sports a full testing harness.Cookies also supports API access fromJavaor viaplain HTTP.ContributingBuilding the SDKYou must have Python3 >=3.6, <= 3.9installed on your system to install and run this SDK. This SDK package depends on other Python packages like nose, jsonpickle etc. These dependencies are defined in therequirements.txtfile that comes with the SDK.To resolve these dependencies, you can use the PIP Dependency manager. Install it by following steps athttps://pip.pypa.io/en/stable/installing/.Python and PIP executables should be defined in your PATH. Open command prompt and typepip --version. This should display the version of the PIP Dependency Manager installed if your installation was successful and the paths are properly defined.Using command line, navigate to the directory containing the generated files (includingrequirements.txt) for the SDK.Run the commandpip install -r requirements.txt. This should install all the required dependencies.DevelopmentThe following section explains how to use the cookiesapi library in a new project.1. Open Project in an IDEOpen up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.Click onOpenin PyCharm to browse to your generated SDK directory and then clickOK.The project files will be displayed in the side bar as follows:2. Add a new Test ProjectCreate a new directory by right clicking on the solution name as shown below:Name the directory as "test".Add a python file to this project.Name it "testSDK".In your python file you will be required to import the generated python library using the following code linesfromcookiesapi.cookiesapi_clientimportCookiesapiClientAfter this you can write code to instantiate an API client object, get a controller object and  make API calls. Sample code is given in the subsequent sections.3. Run the Test ProjectTo run the file within your test project, right click on your Python file inside your Test project and click onRunTest the SDKYou can test the generated SDK and the server with test cases.unittestis used as the testing framework andnoseis used as the test runner. You can run the tests as follows:Navigate to the root directory of the SDK and run the following commandspip install -r test-requirements.txt
nosetests🍪 Copyright © Cookies Creative Consulting & Promotions, Inc.This repository contains private computer source code owned by Cookies (heretofore Cookies Creative Consulting & Promotions, a California Company). Use of this code in source or object form requires prior written permission from a duly-authorized member of Cookies Engineering. All rights reserved.