Prerequisites
- PIP, Python 3.12
📘 Note
📘 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 PIP Samples
1 maintainer
Metadata
1 maintainer
Release files for nomad-media-pip 0.1.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| nomad_media_pip-0.1.9.tar.gz | 88.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nomad_media_pip-0.1.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 327.9 kB
Release files / nomad_media_pip-0.1.9.tar.gz
| Download URL | nomad_media_pip-0.1.9.tar.gz |
|---|---|
| Size | 88.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b1d33db35b16cf4b11f7f0a75426cd7df61178a20eabfdba49cde32bed4fa882
|
|
BLAKE2b-256 checksum How to use checksums |
8bf16ca5c6cebd174ff0cfd6b427abd51fe3d018d342cd75fb60530bcb7e9d8b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.13.0
|
Release files / nomad_media_pip-0.1.9-py3-none-any.whl
| Download URL | nomad_media_pip-0.1.9-py3-none-any.whl |
|---|---|
| Size | 239.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bc9dfd0a482938cc289177a7c056ea9d5e2fac1d0ba778d7b2f3933bde52833e
|
|
BLAKE2b-256 checksum How to use checksums |
df83aabcf564c1dc0dd9b13acd720bf82bf9ebda6e15efb02d76ab6127f6fe6c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.13.0
|
