Skip to main content

Cradlepoint NCMv3 Python Module

This is a Python client library for Cradlepoint NCM APIv3

INSTALL AND RUN INSTRUCTIONS

  1. Install the ncmv3 pip package, or copy the ncmv3.py file into your working directory:

    pip3 install ncmv3
    
  2. Set your NCM APIv3 Key (without the "Bearer" prefix).

    api_key = "babwY0bNYqMwa0Kt0VTRknk6pqmOzNuz"
    
  3. Import the module and create an instance of the NcmClient object:

    If using pip:

    from ncmv3 import ncmv3
    n3 = ncmv3.NcmClient(api_key=api_key)
    

    If not using pip:

    import ncmv3
    n3 = ncm.NcmClient(api_key=api_key)
    
  4. Call functions from the module as needed. For example:

    print(n3.get_users())
    

USAGE AND TIPS:

This python class includes a few optimizations to make it easier to work with the API. Cradlepoint's max page size is 50. This module allows specifying a higher limit than 50, which will handle page parsing automatically.

This can be modified by specifying a "limit parameter":

n3.get_accounts(limit=10)

You can also return the full list of records in a single array without the need for paging by passing limit=0:

n3.get_accounts(limit=0)

Metadata

Release files for ncmv3 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ncmv3 0.0.3
File Size Uploaded Provenance Actions
ncmv3-0.0.3.tar.gz 11.0 kB Without provenance Details for ncmv3-0.0.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ncmv3 0.0.3
File Interpreter ABI Platform Actions
ncmv3-0.0.3-py3-none-any.whl Python 3 none any Details for ncmv3-0.0.3-py3-none-any.whl

Total release size: 21.6 kB

Release files / ncmv3-0.0.3.tar.gz

Download URL ncmv3-0.0.3.tar.gz
Size 11.0 kB
Tags Source
SHA-256 checksum
How to use checksums
b504015845306029e6e5f6156a30640940b2b92818e5def47c72fcfd032fdbae
BLAKE2b-256 checksum
How to use checksums
a214a5736630b1af8c842f65ea7e3d6e33e1f785c18d7a491e4bd1ac687702b0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.8

Release files / ncmv3-0.0.3-py3-none-any.whl

Download URL ncmv3-0.0.3-py3-none-any.whl
Size 10.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5642e47bd5bf3c86abeed0e9c094c356bde51a9e7790a1140001cc2d6399587b
BLAKE2b-256 checksum
How to use checksums
687de0cac18b4231a34b5c42ea8e52dbda8308ef8d43b8e4886fefe96ad008a0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.8

Security for ncmv3 0.0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page