EgyTech FYI Python Wrapper
  • Introduction
  • Quick Start
  • Reference
    • API Reference
      • Participants
      • Stats
      • PoolingClient
      • ParticipantsQueryParams
      • StatsQueryParams
    • Examples
      • Using The Pooling Client
Powered by GitBook
On this page
  • egytech_api.core.PoolingClient(pydantic.BaseModel)
  • Attributes
  • Methods
  • get_df()
  • save_csv(filename: str)
  • save_excel(filename: str)
  1. Reference
  2. API Reference

PoolingClient

The PoolingClient object used for fetching information through different API calls, each with different parameters.

PreviousStatsNextParticipantsQueryParams

Last updated 11 months ago

egytech_api.core.PoolingClient()

Attributes

Name
Type
Description

queries

The list of queries to-be-executed.

Note: There is nothing to guarantee that the fetched participants via this object don't have duplicates. It's up to you to use this data and infer from it at your own risk.

Example:

Query 1: Participants whose companies work on B2B solutions and have a cs degree.

Query 2: Females who work in front-end and have a cs degree.

Among these 2 queries, a female could fulfill both sets of criteria. The wrapper doesn't currently implement safeguards to prevent duplicates in query results.

Methods

get_df()

Returns a instance of the aggregated participant data from the queries.

Parameters

No parameters

Returns

Type
Description

save_csv(filename: str)

Parameters

Name
Type
Description
Example

filename

str

The name of the .csv file to dump the fetched participant data in (without extension). No extension is needed explicitly as it's added during the file-saving process.

"my_awesome_data"

Returns

None

save_excel(filename: str)

Parameters

Name
Type
Description
Example

filename

str

The name of the .xlsx file to dump the fetched participant data in (without extension). No extension is needed explicitly as it's added during the file-saving process.

"my_awesome_data"

Returns

None

list[]

A instance containing the fetched data as one row per fetched participant.

This method is simply a placeholder for the method. It simply saves the generated instance to a .csv file and excludes the index. You can customize your own function parameters for this by simply calling the method, and manipulating the resulting as you want.

This method is simply a placeholder for the method. It simply saves the generated instance to a .xlsx file and excludes the index. You can customize your own function parameters for this by simply calling the method, and manipulating the resulting as you want.

This function uses "xlsxwriter" as the excel writer engine by default. Customization is available by calling on a instance instead.

pydantic.BaseModel
pandas.DataFrame
pandas.DataFrame.to_csv()
pandas.DataFrame
get_df()
pandas.DataFrame
pandas.DataFrame.to_excel()
pandas.DataFrame
get_df()
pandas.DataFrame
to_excel()
pandas.DataFrame
ParticipantsQueryParams
pandas.DataFrame
pandas.DataFrame