Quick Start

Install egytech_api

This package requires Python 3.11 or older. In order to install it with pip, use the following command:

Python

pip install egytech_api

Make your first API request

Since the EgyTech API does not implement any authorization procedures or rate limits, we can freely make anonymous requests directly with no authorization. We'll jump right to that!

Create a Participants Client Instance

Now let's make a simple Participants object that fetches survey responders who work in back-end and have computer science degrees.

from egytech_api.core import Participants

# Create a Participants object
participants = Participants(title="backend", cs_degree=True)

Export Your Data to a pandas.DataFrame Instance

Now, let's export the data we got from the egytech_api to a nice pandas DataFrame, which we can use for manipulation or visualization.

# Export the data as pandas.DataFrame
df = participants.get_df()

# Print the first 5 rows of the dataframe
df.head()

Note: Boolean values all support any non-strict boolean input supported by Pydantic. Find them here. However, it's advised that you stick to strict boolean values supported by native Python.

Output of the above code snippet: