Skip to main content

Python API client for MarkUs

Project description

Markus API

Python interface to the api for a MarkUs instance.

Installation

Install this package with pip:

$ pip install markusapi

Requirements

  • python 3.6+
  • the url of a running MarkUs website
  • your api_key (this can be obtained from the dashboard page of the MarkUs website)

Compatibility

  • version 0.2 of this package is compatible with MarkUs version < 2.0
  • version 0.3 of this package is compatible with MarkUs version >= 2.0

Usage Example

Create a new Markus Api object:

import markusapi

api_key = 'mysecretapikey='
url = 'https://localhost:3000'

api = markusapi.Markus(api_key, url)

Print all user information

user_info = api.get_all_users()
print(user_info)

Additional Info

Check out the MarkUs API documentation for details on API calls:

https://github.com/MarkUsProject/Markus/wiki/RESTfulApiDocumentation

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

markusapi-0.5.0.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

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

markusapi-0.5.0-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: markusapi-0.5.0.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for markusapi-0.5.0.tar.gz
Algorithm Hash digest
SHA256 d12848def1c6252b5766007aa101d757c13df60e8611213211f0b3b5c0c8e832
MD5 f025cc4e32f2ddd1bdb9e401b0b5f360
BLAKE2b-256 9a49227e921113de3d163147df5ac7e9a0c4468b6b2cce407323dc841b8a4ebd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: markusapi-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for markusapi-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 accc63082dcd12ff67716418961c27ee6220a33527cc87d44d83bf238239a33f
MD5 4cfa20763b931a7ca3c18b9fffe6d292
BLAKE2b-256 8b98c9c60b296b13b18e9974833ef84e39cf55db289db095e5180eda1f5cbc8d

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