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.0.0.tar.gz (3.8 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.0.0-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: edgegap_api-1.0.0.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.0 CPython/3.10.11 Linux/5.15.0-1058-aws

File hashes

Hashes for edgegap_api-1.0.0.tar.gz
Algorithm Hash digest
SHA256 481eb8a758ed04ae4b20a8aa4851b0690775e6b706ca1cdcc3b919ee5e274f6c
MD5 3f1aad78b53219512b6219a1ca05edad
BLAKE2b-256 36110c619de1d526974f009d83d19766c03c153ccd9b4a0a1b509e2f579ae210

See more details on using hashes here.

File details

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

File metadata

  • Download URL: edgegap_api-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 4.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.0 CPython/3.10.11 Linux/5.15.0-1058-aws

File hashes

Hashes for edgegap_api-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8bdd5bd92ed338bb9b9f5dc1f02cd4bc19ae9f03decc6de3f3b8675ace6e9bcc
MD5 99325cefa7e8863a91f6034d56efb59f
BLAKE2b-256 f1ea6cbc9cc7cbede88f94a6e3dd07b2e0548f17971e444f21489cdd9d18236c

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