so4t-api 0.1.0

An API wrapper for Stack Overflow for Teams

Stack Overflow for Teams API Wrapper (so4t_api_wrapper)

A Python wrapper for the Stack Overflow for Teams API, replicating the functionality of the Stack Overflow for Teams API in a more user-friendly way.

Full documentation for the API can be found at one of the following locations:

• Basic/Business API: https://api.stackoverflowteams.com/v3
• Enterprise API: https://YOUR.INSTANCE.URL/api/v3

Table of Contents

• Setup
• Usage
• Support

Setup

Install

Install the package using pip:

python3 -m pip install so4t_api

If you're running Windows, you'll probably need to use py instead of python3

API Authentication

To authenticate with the Stack Overflow API, you will need to generate a valid access token.

• For Basic or Business, instructions for creating a personal access token (PAT) can be found in this KB article.
• For Enterprise, follow the instructions in the KB article titled Secure API Token Generation Using OAuth with PKCE

NOTE: For Enterprise, if you'll be performing any API tasks that require posting or editing content (i.e. anything beyond just getting/reading content), you'll need to make sure to include the write_access scope when generating your token; otherwise, you will not be able to make the necessary updates to content via the API.

ANOTHER NOTE: For Enterprise, if you'll be using any of the impersonation methods, this will additionally require an API key, which will be submitted as an argument when instantiating StackClient. It will also require enabling impersonation, which involves sending a request to [e-mail].

Usage

A basic example of how to use the wrapper in an application:

import os
from so4t_api import StackClient

# instantiate the StackClient
stack = StackClient(url=os.environ["SO_URL"], token=os.environ["SO_TOKEN"]) 

# get all questions
questions = stack.get_questions() 

# Calculate total page views
total_views = 0
for question in questions:
    total_views += question["viewCount"]
print(f"Total page views across {len(questions)} questions: {total_views}")

At this time, most/all the documentation for wrapper methods is documented along side the methods (i.e. in the code)

Support

Disclaimer: the creator of this project works at Stack Overflow, but it is a labor of love that comes with no formal support from Stack Overflow.

If you run into issues using the script, please open an issue. You are also welcome to edit the script to suit your needs, steal the code, or do whatever you want with it.