Skip to main content

SimproAPI

Intended to be a Structured way to interface with Simpro's API.
Its currently focused on the Plants & Equipment section of Simpro.

Has classes and methods for:

  • Token Management - Get/Load/save/update
  • Iterating over Plants & equipment to find trackable's

Usage

Firstly you need to make up an instance of the TokenManager Class.
This Class will be used to pass the retrieved Token to other methods later

simpro_token=SimproAPI.TokenManager(
	server='https://XXXXXXXX.simprocloud.com'
	client_id='XXXXXXXXXXXXXXXXXXXXX'
	client_secret='XXXXXXXXXXXXXXXXXXXXX'
	username='XXXXXXXXXXXXXXXXXXXXX'
	password='XXXXXXXXXXXXXXXXXXXXX'
	save_location='simpro_token.json'
)
simpro_token.load_token() #Loads any token information in the save_location json file
simpro_token.update_token() # Check if the token is expired and renews if so.

Once the above is done we can actually pull some information from Simpro

with SimproAPI.trackables(simpro_token.server,simpro_token.access_token) as trackables:
    trackables.get_companies(
        9000, #your_company_id
        [Serial,Location ] #list of custom_fields you are tracking
    )

The above Method is a big one. It will use sessions to iterate over the company and all plant types within.
If the plant type has the custom fields specified it will then iterate over all plants and return the custom fields specified.

Installation

pip install SimproAPI

Metadata

Release files for SimproAPI 0.1.8

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

Source distribution (sdist)

Source distribution for SimproAPI 0.1.8
File Size Uploaded
SimproAPI-0.1.8.tar.gz 10.7 kB Details

Built distribution (wheel)

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

Total release size: 22.6 kB

Release files / SimproAPI-0.1.8.tar.gz

Download URL SimproAPI-0.1.8.tar.gz
Size 10.7 kB
Tags Source
SHA-256 checksum
How to use checksums
f216d464fde0a5eb50bed80561972288d3ddf8ab5060ad289304ab3199a9b115
BLAKE2b-256 checksum
How to use checksums
36b07d0c8af7addc32b8690aef5ef17f7a848364ec511c69575b724b851f457b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.9.6

Release files / SimproAPI-0.1.8-py3-none-any.whl

Download URL SimproAPI-0.1.8-py3-none-any.whl
Size 11.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8c26144c288a4f34f11e240092c7d70d55012389e2a2edd927c170c64d01e373
BLAKE2b-256 checksum
How to use checksums
7d5825da268b6b3ab68f802c83fa6fca856f394d5bac68669cdbc169cfd23546
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.9.6

Release history Release notifications | RSS feed

This release

0.1.8 This release

2 release files

0.1.2

3 release files

0.1.1

2 release files

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