supermq-sdk-py

Python SDK for SuperMQ

https://github.com/absmach/supermq-sdk-py

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Python SDK for SuperMQ

Basic Info
  • Host: GitHub
  • Owner: absmach
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 114 KB
Statistics
  • Stars: 4
  • Watchers: 7
  • Forks: 5
  • Open Issues: 1
  • Releases: 0
Created almost 5 years ago · Last pushed over 2 years ago
Metadata Files
Readme Contributing License

README.md

Python SDK

Testing Check SDK documentation

This is the Mainflux Python SDK, a python driver for Mainflux HTTP API API reference in the Swagger UI can be found here.

Does both system administration (provisioning) and messaging.

Installation

To install mainflux SDK to your system you will need to have pip installed.

  1. To install in a virtual environment

sh virtualenv mainfluxVenv --python=python3.8 source mainfluxVenv/bin/activate pip install mainflux

  1. To install system wide

sh pip install mainflux

Usage

You can interact with the mainflux API by calling the various Python SDK functions.

First you need to start mainflux in your system by following the guide here

```python from mainflux import SDK

default_url = "http://localhost"

sdk = SDK()

Example to create an account

mfresp = sdk.users.create({"email": "<useremail>", "password": ""}) if mfresp.error.status == 0: print(mfresp.value) else: print(mf_resp.error.message) ```

Documentation

Official documentation for the SDK is hosted at here. Documentation is auto-generated, the instructions to generate one are:

sh pip install lazydocs requests python3 setup.py install lazydocs --src-base-url="https://github.com/mainflux/sdk-py/blob/main/" --overview-file="README.md" mainflux

Please note that lazydocs requires Python version 3.5 or higher.

If you spot an error or a need for corrections, please let us know - or even better: send us a PR.

Professional Support

There are many companies offering professional support for the Mainflux system.

If you need this kind of support, best is to reach out to @drasko directly, and he will point you out to the best-matching support team.

Contributing

Thank you for your interest in Mainflux and the desire to contribute!

  1. Take a look at our open issues. The good-first-issue label is specifically for issues that are great for getting started.
  2. Checkout the contribution guide to learn more about our style and conventions.
  3. Make your changes compatible to our workflow.

Community

License

Apache-2.0

Owner

  • Name: Abstract Machines
  • Login: absmach
  • Kind: organization
  • Email: info@abstractmachines.fr

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 16
  • Total pull requests: 27
  • Average time to close issues: 3 months
  • Average time to close pull requests: 13 days
  • Total issue authors: 4
  • Total pull request authors: 3
  • Average comments per issue: 1.5
  • Average comments per pull request: 1.22
  • Merged pull requests: 23
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • drasko (12)
  • rodneyosodo (1)
  • kitty7c6 (1)
  • dborovcanin (1)
Pull Request Authors
  • rodneyosodo (22)
  • fbugarski (2)
  • Musilah (1)
Top Labels
Issue Labels
enhancement (3)
Pull Request Labels

Dependencies

.github/workflows/docs.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/python-testing.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite