Edgegap API Library

This is the README for the Edgegap API Helper, which is part of the Edgegap suite of helpers. This library provides utilities for interacting with various APIs using Asyncio.

Table of Contents

Overview

The Edgegap API library includes various tools and helpers for interacting with RESTful and other types of APIs. It is designed for use within the Edgegap organization.

Installation

To install this library, ensure you have Python and poetry installed. Then, use the following command:

poetry add edgegap-api

Ensure you have the necessary permissions to install and use this library, as it is intended for Edgegap employees only.

Usage

Please consult Obsidian Documentation for Usage

Running Tests

To run tests for this library, you need to have pytest installed. You can install dev dependencies with:

poetry install --with=dev

then run

pytest

This will execute all the tests in the tests folder.

Uploading Package

To upload the distribution to pypi, you will need an API token from Pypi

poetry config pypi-token.pypi <your-api-token>
poetry version x.x.x
poetry publish --build

Contributing

If you'd like to contribute to this library and you're an Edgegap employee, please follow these steps:

  • Fork the repository.
  • Create a new branch for your changes (e.g., feature/my-feature).
  • Commit your changes with a clear message.
  • Push your branch to your fork.
  • Open a Pull Request, explaining the changes and providing any necessary context.

License

This software is proprietary to Edgegap. Only current Edgegap employees are allowed to use this library. Refer to the LICENSE file for detailed licensing information.

Contact

For support or questions related to this library, please contact support@edgegap.com.

Acknowledgements

Thanks to the Edgegap development team for creating and maintaining this library.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.9.12)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for bastien9222 from gravatar.com bastien9222

Credits

Author: Bastien Roy

Requires

Python <4.0, >=3.10

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

edgegap_api-1.5.2.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

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

edgegap_api-1.5.2-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file edgegap_api-1.5.2.tar.gz.

File metadata

  • Download URL: edgegap_api-1.5.2.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.13 Darwin/23.4.0

File hashes

Hashes for edgegap_api-1.5.2.tar.gz
Algorithm Hash digest
SHA256 c4f7b4cb5147838d3b4f744cef0107a6d6a2c0a8b7dff394a0a857f94d567292
MD5 bdc2bb6f719bed6a20e2f0de1bf9e1a0
BLAKE2b-256 b284cf5aee80cb04bb8a5d5257edfa06c039f423ac10676f0b3a5813117f634d

See more details on using hashes here.

File details

Details for the file edgegap_api-1.5.2-py3-none-any.whl.

File metadata

  • Download URL: edgegap_api-1.5.2-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.13 Darwin/23.4.0

File hashes

Hashes for edgegap_api-1.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d99a2981f3a08843145311d7245b68667c822a9480f770ce96b816508aa256f0
MD5 e1c0027991e4fe54ca6b7e2520863697
BLAKE2b-256 ecac8a6037b4501c10b5c068c3887a5c3682e3af375d845c16b51245656e3590

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 Sentry Error logging StatusPage Status page