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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file edgegap_api-1.5.0.tar.gz.
File metadata
- Download URL: edgegap_api-1.5.0.tar.gz
- Upload date:
- Size: 3.9 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
66b0064dd89779b7f322d0b0129d66eaea3169d741dc3e1299245e384d6dc44b
|
|
| MD5 |
f911179356495c4a7d6a20c6986307fd
|
|
| BLAKE2b-256 |
f51f82dfe5ffd96f6361a204c05160762fb6b73c1caf57e3436889984b65db2b
|
File details
Details for the file edgegap_api-1.5.0-py3-none-any.whl.
File metadata
- Download URL: edgegap_api-1.5.0-py3-none-any.whl
- Upload date:
- Size: 4.9 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
13084b767d368af5369aad85dfbc0813d2b0ef51302e21b7e565f6f148eb80b2
|
|
| MD5 |
fc133f7197c6a320af1ab02f7658a14d
|
|
| BLAKE2b-256 |
6529591926b58227305f1a1ab8cba9fec41b54b5c279609266cdfe677edc2847
|
