| Name | pyazureutils JSON |
| Version |
1.1.4.9
JSON |
| download |
| home_page | |
| Summary | A collection of utilities for interacting with Microsoft Azure |
| upload_time | 2023-12-13 12:29:50 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
microchip
azure
pic-iot
sam-iot
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyazureutils
pyazureutils is a collection of utilities for interacting with Microsoft Azure.
## Overview
pyazureutils is available:
* install using pip from pypi: https://pypi.org/project/pyazureutils
* browse source code on github: https://github.com/microchip-pic-avr-tools/pyazureutils
* read API documentation on github: https://microchip-pic-avr-tools.github.io/pyazureutils
* read the changelog on github: https://github.com/microchip-pic-avr-tools/pyazureutils/blob/main/CHANGELOG.md
## Usage
pyazureutils is intended as a library as well as a stand-alone CLI.
Its primary consumer is iotprovision.
The CLI requires that the Azure CLI ('az') is installed.
## Command-line interface
pyazureutils CLI is invoked with one command, one action and optional switches. See help and examples below for more details.
Getting help:
```bash
pyazureutils --help
```
Getting command-specific help (iotcentral command):
```bash
pyazureutils iotcentral --help
```
pyazureutils can optionally select the subscription to use:
Example:
```bash
pyazureutils --subscription "My Azure" iotcentral register-device
```
### iotcentral command
The iotcentral command supports device registration with Azure IoT Central
Example:
```bash
pyazureutils iotcentral register-device
```
Device registration can optionally include the switches:
```
--application-name <application name (URL) to register with>
--display-name <display name to use for the device registration>
--certificate-file <certificate to use for registration, if not read from a kit>
--device-template-name <device template to use for registration>
```
Example:
```bash
pyazureutils --subscription "My Azure" iotcentral register-device --app custom-227clcx93h8 --template "PIC-IoT WM" --display-name "My PIC-IoT Kit"
```
## Logging
This package uses the Python logging module for publishing log messages to library users.
A basic configuration can be used (see example below), but for best results a more thorough configuration is
recommended in order to control the verbosity of output from dependencies in the stack which also use logging.
```python
import logging
logging.basicConfig(format="%(levelname)s: %(message)s", level=logging.WARNING)
```
## Dependencies
This package uses pyedbglib through other libraries for USB communications. For more information see: https://pypi.org/project/pyedbglib/.
## Versioning
pyazureutils version can be determined by:
```python
from pyazureutils import __version__ as pyazureutils_version
print(f"pyazureutils version {pyazureutils_version}")
```
# Changelog
## [1.1] - December 2023
### Added
- DSG-5753 CLI catch-all and return code
### Fixed
- DSG-5640 Clean up unused pyedbglib dependencies / requirements
- DSG-5754 Removed erroneous relic: AzureCustomProvisioner
## [1.0.0] - July 2022
### Fixed
- DSG-4387 corrections to pyazureutils library help
- DSG-4718 Attempt iotcentral enrollment even if app name is not visible in subscription
- DSG-5151 Support for setting the default subscription before enrollment
### Added
- DSG-4398 Link to github readme to github docs for pyazureutils
- DSG-4471 Link to changelog
- DSG-4727 Argument aliases for enrollment (--app, --application-name, --application-url)
## [0.8.2] - December 2021
### Fixed
- DSG-4296 Better feedback when multiple subscriptions or IoT Central applications found
- DSG-4293 Better device template handling
### Changed
- DSG-4355 Improved help
## [0.7.1] - November 2021
### Added
- DSG-4029 Publication to GitHub + pypi
- DSG-4001 Support for multiple subscriptions
- DSG-3442 iotcentral enrollment
### Fixed
- DSG-4004 cross-platform subprocess calls
- DSG-4000 packages dependencies corrected
### Changed
- DSG-3363 refactored provisioning
## [0.6.3] - June 2021
### Added
- DSG-3565 pypi release
## [0.5.0] - January 2021
- First public release to PyPi
Raw data
{
"_id": null,
"home_page": "",
"name": "pyazureutils",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Microchip,Azure,PIC-IOT,SAM-IOT",
"author": "",
"author_email": "Microchip Technology <support@microchip.com>",
"download_url": "",
"platform": null,
"description": "# pyazureutils\npyazureutils is a collection of utilities for interacting with Microsoft Azure.\n\n\n\n\n\n## Overview\npyazureutils is available:\n\n* install using pip from pypi: https://pypi.org/project/pyazureutils\n* browse source code on github: https://github.com/microchip-pic-avr-tools/pyazureutils\n* read API documentation on github: https://microchip-pic-avr-tools.github.io/pyazureutils\n* read the changelog on github: https://github.com/microchip-pic-avr-tools/pyazureutils/blob/main/CHANGELOG.md\n\n\n## Usage\npyazureutils is intended as a library as well as a stand-alone CLI.\nIts primary consumer is iotprovision.\nThe CLI requires that the Azure CLI ('az') is installed.\n\n## Command-line interface\npyazureutils CLI is invoked with one command, one action and optional switches. See help and examples below for more details.\n\nGetting help:\n```bash\npyazureutils --help\n```\n\nGetting command-specific help (iotcentral command):\n```bash\npyazureutils iotcentral --help\n```\n\npyazureutils can optionally select the subscription to use:\n\nExample:\n```bash\npyazureutils --subscription \"My Azure\" iotcentral register-device\n```\n\n### iotcentral command\nThe iotcentral command supports device registration with Azure IoT Central\n\nExample:\n```bash\npyazureutils iotcentral register-device\n```\n\nDevice registration can optionally include the switches:\n```\n--application-name <application name (URL) to register with>\n--display-name <display name to use for the device registration>\n--certificate-file <certificate to use for registration, if not read from a kit>\n--device-template-name <device template to use for registration>\n```\n\nExample:\n```bash\npyazureutils --subscription \"My Azure\" iotcentral register-device --app custom-227clcx93h8 --template \"PIC-IoT WM\" --display-name \"My PIC-IoT Kit\"\n```\n\n## Logging\nThis package uses the Python logging module for publishing log messages to library users.\nA basic configuration can be used (see example below), but for best results a more thorough configuration is\nrecommended in order to control the verbosity of output from dependencies in the stack which also use logging.\n```python\nimport logging\nlogging.basicConfig(format=\"%(levelname)s: %(message)s\", level=logging.WARNING)\n```\n\n## Dependencies\nThis package uses pyedbglib through other libraries for USB communications. For more information see: https://pypi.org/project/pyedbglib/.\n\n## Versioning\npyazureutils version can be determined by:\n```python\nfrom pyazureutils import __version__ as pyazureutils_version\nprint(f\"pyazureutils version {pyazureutils_version}\")\n```\n# Changelog\n\n## [1.1] - December 2023\n\n### Added\n- DSG-5753 CLI catch-all and return code\n\n### Fixed\n- DSG-5640 Clean up unused pyedbglib dependencies / requirements\n- DSG-5754 Removed erroneous relic: AzureCustomProvisioner\n\n## [1.0.0] - July 2022\n\n### Fixed\n- DSG-4387 corrections to pyazureutils library help\n- DSG-4718 Attempt iotcentral enrollment even if app name is not visible in subscription\n- DSG-5151 Support for setting the default subscription before enrollment\n\n### Added\n- DSG-4398 Link to github readme to github docs for pyazureutils\n- DSG-4471 Link to changelog\n- DSG-4727 Argument aliases for enrollment (--app, --application-name, --application-url)\n\n## [0.8.2] - December 2021\n\n### Fixed\n- DSG-4296 Better feedback when multiple subscriptions or IoT Central applications found\n- DSG-4293 Better device template handling\n\n### Changed\n- DSG-4355 Improved help\n\n## [0.7.1] - November 2021\n\n### Added\n- DSG-4029 Publication to GitHub + pypi\n- DSG-4001 Support for multiple subscriptions\n- DSG-3442 iotcentral enrollment\n\n### Fixed\n- DSG-4004 cross-platform subprocess calls\n- DSG-4000 packages dependencies corrected\n\n### Changed\n- DSG-3363 refactored provisioning\n\n## [0.6.3] - June 2021\n\n### Added\n- DSG-3565 pypi release\n\n## [0.5.0] - January 2021\n- First public release to PyPi\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A collection of utilities for interacting with Microsoft Azure",
"version": "1.1.4.9",
"project_urls": {
"Homepage": "https://github.com/microchip-pic-avr-tools/pyazureutils"
},
"split_keywords": [
"microchip",
"azure",
"pic-iot",
"sam-iot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aea2896b3288bb26d7c52537b7a3f046b32a9a44f2497c4250efe5f698aeea1c",
"md5": "b9c25a453dff453a2216be7b863f3e00",
"sha256": "297f45dfd45ceaa2ef610d973e0faad34d46b9a825c4b15842b73cbbef4691ac"
},
"downloads": -1,
"filename": "pyazureutils-1.1.4.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b9c25a453dff453a2216be7b863f3e00",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 16832,
"upload_time": "2023-12-13T12:29:50",
"upload_time_iso_8601": "2023-12-13T12:29:50.317247Z",
"url": "https://files.pythonhosted.org/packages/ae/a2/896b3288bb26d7c52537b7a3f046b32a9a44f2497c4250efe5f698aeea1c/pyazureutils-1.1.4.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-13 12:29:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "microchip-pic-avr-tools",
"github_project": "pyazureutils",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyazureutils"
}
