nomad-media-pip 0.1.8a1

Nomad Media SDK PIP

Prerequisites

• PIP, Python 3.12

📘 Note

You can download PIP here and Python 3.12 here.

📘 Note

To learn how to update python 3.12 in your terminal, go here.

Setup

• First, open up a terminal and navigate to the directory of the sample you want to run.
• Then install the nomad_media_pip pip.

pip install nomad_media_pip

Importing Pip

• To import the sdk from the pip, import the class from nomad_media_pip.nomad_sdk.

 from nomad_media_pip.src.nomad_sdk import Nomad_SDK

• To initialize the sdk, create the class as shown below.

 nomad_sdk = Nomad_SDK(config)

Logging in

To log in to the sdk, in the config, enter the username/email of your user. Then enter your api key if you are using an api key, or your password.

Configure Environmental Variables

• The format of the config is:

config = {
    "username": "username",
    "password": "password",
    "apiKey": "apiKey",
    "serviceApiUrl": "serverApiUrl",
    "apiType": "admin",
    "debugMode": "debugMode",
    "singleton": "singleton"
}

apiType: Specifies whether the function you are trying to run is admin or portal.

debugMode: Boolean that specifies when running functions, whether of not to print api call information.

singleton: Whether or not to only create one class instance.

Place the config in a file called config.py and import it into your project.

You are now ready to use the Pip in your project.

📘 Make sure to keep your configuration options secret and do not share them publicly.

Upgrading Pip

• To upgrade the pip, use the following command:

pip install --upgrade nomad_media_pip

Nomad SDK References

Scroll down to the Nomad SDK section.

Nomad SDK References

Nomad SDK PIP Samples

Nomad SDK PIP Samples