A Python API Wrapper for the EgyTech.FYI API
Project description
Egytech API
A simple python wrapper for Egytech's API.
Description
- This python wrapper leverages the type safety and input validity checking of pydantic. It creates enums for all user-side inputs, making sure that all outgoing api requests are correct. It also leverages request pooling offered by httpx. This leads to more performant api requests when making multiple requests in a short period of time. This is my first project with pydantic. Feedback is appreciated.
- It also allows the user to extract the api call results as a pandas dataframe, making any visualization or data manipulation easier to do.
- You can extract the data in csv, or xslx format immediately. This uses pandas under the hood. However, you can extract a pandas dataframe and do whatever you want with it.
Getting Started
Dependencies
- This project uses python 3.11, any newer python version should work.
- This project is os-agnostic, it should work on any os with a python interpreter.
Installing
- To install with pip, run the following command:
pip install egytech_api
Quickstart
To make a simple API request that fetches survey data of participants who have a computer science degree and a "backend" job title, you can do the following:
from egytech_api.core import Participants
# Create a Participants object
participants = Participants(title="backend", cs_degree=True)
# Fetch the data
df = participants.get_df()
# Print the first 5 rows of the dataframe
df.head()
Full Documentation
The full documentation can be found here.
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
egytech_api-1.0.1.tar.gz
(4.7 kB
view hashes)
Built Distribution
Close
Hashes for egytech_api-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd97b5021d76cb6c841b4dd32918b1363b330d740804c791f69e4fc5281cf564 |
|
MD5 | 4ad2fd298497b10bc4ba0c6744b6b563 |
|
BLAKE2b-256 | 1189ac484043529681d836284d3c284d184c8839f0d906dfd35586b5f04d0c48 |