Skip to main content

Python library that simplifies access to the Public CodeOffer API

Project description

CodeOffer Python Package

This is a Python package that provides an API wrapper for the public CodeOffer API. The package simplifies authentication and management of in-app assets for developers who use the CodeOffer API in their applications.

Installation

To install the package, run the following command:

pip install codeoffer

Usage

Import the codeoffer class from the package:

Authentication & Sessions

Initialize a new session, but first you need to import the oauth class from codeoffer

from codeoffer import oauth

After that you can create a new session token:

token = session.create_session_token()

Now get the login link and ask the user to log in: token.get_login_link()

Right after that call the token.wait_for_confirmation() method, this method will wait until the user completed the login-process.

To return the current logged in user you need to import the user class from codeoffer

from codeoffer import user

Then you can return the current user by using the get_user method and passing the token as a parameter:

user = user.User.get_user(token)

And now you can get the username, email, profile picture and access to the current logged in app (if the user purchased / downloaded the app with his account)

print(f"Hey {user.username}")

Assets

You can return all the apps your app contains.

First import the app class from codeoffer

from codeoffer import app

Then you need to initialize the app with a session token.

app = app.App.by_session_token(token)

After that you can return all the assets your app contains and return properties like the name, identifier and if the user has access to that asset.

assets = app.get_asset_directory()

for asset in assets:  
    print(f"{asset.name}: {asset.access}")

Complete Example

from codeoffer import oauth  
from codeoffer import app  
from codeoffer import user  

session = oauth.Session("10aa641e562bdd82d2f8449d")  
token = session.create_session_token()  
token.get_login_link()  
token.wait_for_confirmation()  
user = user.User.get_user(token)  
print(f"Hey {user.username}")  
app = app.App.by_session_token(token)  
assets = app.get_asset_directory()  
for asset in assets:  
    print(f"{asset.name}: {asset.access}")

License

This package is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codeoffer-0.5.0.tar.gz (2.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codeoffer-0.5.0-py3-none-any.whl (2.0 kB view details)

Uploaded Python 3

File details

Details for the file codeoffer-0.5.0.tar.gz.

File metadata

  • Download URL: codeoffer-0.5.0.tar.gz
  • Upload date:
  • Size: 2.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.9

File hashes

Hashes for codeoffer-0.5.0.tar.gz
Algorithm Hash digest
SHA256 f97055285d05a460fa1a8258c32fbedd19fd93327852440091675232d0975311
MD5 d1c695fcaef2a276f0fe35c8bb209ab2
BLAKE2b-256 20639970e15b8819443b44aae83a5a2c1899eeb9b165d6f3acc8cd0e97f2f600

See more details on using hashes here.

File details

Details for the file codeoffer-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: codeoffer-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 2.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.9

File hashes

Hashes for codeoffer-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dc8e114f7181ed26ccdc5bd3698a5774175e6552be98eb53d448dff71cfcc7a7
MD5 c4abe261905c2f1189b4351cea49cb9c
BLAKE2b-256 790a1667995a0084d0b359e3425f2fc098b6418c9fe051106c642e588532ba5a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page