From f93cc4365eda7defed2ffa00cf8d6091d3eb3ae6 Mon Sep 17 00:00:00 2001 From: Nedhir Ebnou Date: Tue, 3 Dec 2024 16:38:52 +0100 Subject: [PATCH] fix: add data flows and import graphs to connectors' documentations --- .../v2/connectors/admen/README.md | 21 +++++-- .../v2/connectors/admen/connector.py | 4 +- .../v2/connectors/bullhorn/README.md | 20 +++++- .../v2/connectors/hubspot/README.md | 4 +- .../v2/connectors/recruitee/README.md | 62 +++++++++---------- .../v2/connectors/recruitee/connector.py | 12 ++-- .../v2/connectors/smartrecruiters/README.md | 52 ++++++++-------- .../v2/connectors/zohorecruit/README.md | 11 +++- 8 files changed, 111 insertions(+), 75 deletions(-) diff --git a/src/hrflow_connectors/v2/connectors/admen/README.md b/src/hrflow_connectors/v2/connectors/admen/README.md index 77f589e8..549bf572 100644 --- a/src/hrflow_connectors/v2/connectors/admen/README.md +++ b/src/hrflow_connectors/v2/connectors/admen/README.md @@ -14,8 +14,8 @@ # πŸ’Ό About Admen > -Besoin d'une solution RH efficace et performante pour la gestion de vos candidatures ? -Misez sur AD-Men, le Logiciel NΒ°1 des Cabinets de Recrutement. +Need an efficient, high-performance HR solution for managing your applications? +Choose AD-Men, the No. 1 software for recruitment agencies. @@ -56,6 +56,12 @@ This new connector will enable:

+

+ +

+ +

# πŸ’ Quick Start Examples @@ -65,6 +71,11 @@ To make sure you can successfully run the latest versions of the example scripts To browse the examples of actions corresponding to released versions of πŸ€— this connector, you just need to import the module like this : +

+ +

+ Once the connector module is imported, you can leverage all the different actions that it offers. For more code details checkout connector code. @@ -72,10 +83,10 @@ For more code details checkout connector code. # πŸ”— Useful Links -- πŸ“„Visit [Admen](https://www.admen.com/) to learn more. +- πŸ“„Visit [Admen](https://www.ad-rh.com/) to learn more. - πŸ’» [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/admen) on our Github. # πŸ‘ Special Thanks -- πŸ’» HrFlow.ai : XXXXX YYYYY - Software Engineer -- 🀝 Admen : XXXXX YYYYY - Partner Manager \ No newline at end of file +- πŸ’» HrFlow.ai : [Nedhir Ebnou](https://github.com/itsnedhir) - Software Engineer +- 🀝 Inasoft : AurΓ©lie CARLESCHI - Operations Director \ No newline at end of file diff --git a/src/hrflow_connectors/v2/connectors/admen/connector.py b/src/hrflow_connectors/v2/connectors/admen/connector.py index cc7c17e1..a834c850 100644 --- a/src/hrflow_connectors/v2/connectors/admen/connector.py +++ b/src/hrflow_connectors/v2/connectors/admen/connector.py @@ -309,8 +309,8 @@ def format_profile_archive_in_admen(hrflow_profile: t.Dict) -> t.Dict: DESCRIPTION = """ -Besoin d'une solution RH efficace et performante pour la gestion de vos candidatures ? -Misez sur AD-Men, le Logiciel NΒ°1 des Cabinets de Recrutement. +Need an efficient, high-performance HR solution for managing your applications? +Choose AD-Men, the No. 1 software for recruitment agencies. """ Admen = Connector( diff --git a/src/hrflow_connectors/v2/connectors/bullhorn/README.md b/src/hrflow_connectors/v2/connectors/bullhorn/README.md index a195068f..4c4cad74 100644 --- a/src/hrflow_connectors/v2/connectors/bullhorn/README.md +++ b/src/hrflow_connectors/v2/connectors/bullhorn/README.md @@ -15,6 +15,13 @@ > Transform Your Business with Bullhorn Staffing and Recruitment Software +

+ +

+ +

+ +

## 😍 Why is it a big deal for Bullhorn customers & partners? @@ -29,11 +36,17 @@ This new connector will enable: - ⬅️ Send Jobs data from Bullhorn to a Destination of your choice. - ➑️ Send Jobs data from a Source of your choice to Bullhorn. +

+ +

## 🧠 Artificial Intelligence capabilities: - Extract, Structure, and Categorize Talent & Workforce data - Search, Score, and Match Profiles & Jobs with our APIs and AI Widgets (**Matching Custom Tab in Bullhorn**) +

+ +

# πŸ”Œ Connector Actions

@@ -58,6 +71,9 @@ To make sure you can successfully run the latest versions of the example scripts To browse the examples of actions corresponding to released versions of πŸ€— this connector, you just need to import the module like this : +

+ +

Once the connector module is imported, you can leverage all the different actions that it offers. @@ -71,5 +87,5 @@ For more code details checkout connector code. # πŸ‘ Special Thanks -- πŸ’» HrFlow.ai : XXXXX YYYYY - Software Engineer -- 🀝 Bullhorn : XXXXX YYYYY - Partner Manager \ No newline at end of file +- πŸ’» HrFlow.ai : [Nedhir Ebnou](https://github.com/itsnedhir) - Software Engineer & Abdellahi Mezid - Software Engineer +- 🀝 Bullhorn : Arne LOOTEN - Partner Manager \ No newline at end of file diff --git a/src/hrflow_connectors/v2/connectors/hubspot/README.md b/src/hrflow_connectors/v2/connectors/hubspot/README.md index 3dc60d96..cd5e23b7 100644 --- a/src/hrflow_connectors/v2/connectors/hubspot/README.md +++ b/src/hrflow_connectors/v2/connectors/hubspot/README.md @@ -44,7 +44,7 @@ In this section, we outline the data flow between different components of the co

-# 🐍 Quick Start Example +# πŸ’ Quick Start Examples To make sure you can successfully run the latest versions of the example scripts, you have to **install the package from PyPi**. @@ -68,6 +68,6 @@ For more code details checkout connector code # πŸ‘ Special Thanks -- πŸ’» HrFlow.ai : [Nedhir Ebnou](https://github.com/nedhirouebnou) - Software Engineer +- πŸ’» HrFlow.ai : [Nedhir Ebnou](https://github.com/itsnedhir) - Software Engineer - 🀝 Hubspot :[Hubspot for the accessible documentation](https://www.hubspot.com) diff --git a/src/hrflow_connectors/v2/connectors/recruitee/README.md b/src/hrflow_connectors/v2/connectors/recruitee/README.md index a4391c1e..4da48b07 100644 --- a/src/hrflow_connectors/v2/connectors/recruitee/README.md +++ b/src/hrflow_connectors/v2/connectors/recruitee/README.md @@ -1,41 +1,39 @@ +# πŸ“– Summary +- [πŸ“– Summary](#πŸ“–-summary) +- [πŸ’Ό About Recruitee](#πŸ’Ό-about-recruitee) + - [😍 Why is it a big deal for Recruitee customers & partners?](#😍-why-is-it-a-big-deal-for-recruitee-customers--partners) +- [πŸ”§ How does it work?](#πŸ”§-how-does-it-work) + - [πŸ“Š Data integration capabilities:](#πŸ“Š-data-integration-capabilities) + - [🧠 Artificial Intelligence capabilities:](#🧠-artificial-intelligence-capabilities) +- [πŸ”Œ Connector Actions](#πŸ”Œ-connector-actions) +- [πŸ’ Quick Start Examples](#πŸ’-quick-start-examples) +- [πŸ”— Useful Links](#πŸ”—-useful-links) +- [πŸ‘ Special Thanks](#πŸ‘-special-thanks) -- [πŸ’Ό About Recruitee](#--about-Recruitee) -- [😍 **What makes this major news for Recruitee customers \& partners?**](#-what-makes-this-major-news-for-Recruitee-customers--partners) -- [πŸ”§ How does it work?](#-how-does-it-work) - - [πŸ“Š Data integration capabilities:](#-data-integration-capabilities) - - [🧠 Artificial Intelligence capabilities:](#-artificial-intelligence-capabilities) -- [πŸ”Œ Connector Actions](#-connector-actions) -- [🐍 Quick Start Examples](#-quick-start-examples) -- [πŸ”— Useful Links](#-useful-links) -- [πŸ‘ Special Thanks](#-special-thanks) -# πŸ’Ό About Recruitee +# πŸ’Ό About Recruitee -Recruitee is an innovative and intuitive recruitment software that empowers businesses to streamline hiring processes and attract top talent. +> Recruitee is an innovative and intuitive recruitment software that empowers businesses to streamline hiring processes and attract top talent. Recruitee provides a comprehensive solution that ensures a seamless and efficient recruitment experience. -Recruitee provides a comprehensive solution that ensures a seamless and efficient recruitment experience. -

- -

- -# 😍 **What makes this major news for Recruitee customers & partners?** +## 😍 Why is it a big deal for Recruitee customers & partners? -This new connector will enable Recruitee customers & partners to: -- ⚑ Seamlessly Integrate Talent & Workforce data -- πŸ€– Elevate their Talent and Recruiter Experiences - -# πŸ”§ How does it work? +This new connector will enable: +- ⚑ A Fastlane Talent & Workforce data integration for Recruitee customers & partners +- πŸ€– Cutting-edge AI-powered Talent Experiences & Recruiter Experiences for Recruitee customers +# πŸ”§ How does it work? ## πŸ“Š Data integration capabilities: +- ⬅️ Send Profiles data from Recruitee to a Destination of your choice. +- ➑️ Send Profiles data from a Source of your choice to Recruitee. +- ⬅️ Send Jobs data from Recruitee to a Destination of your choice. +- ➑️ Send Jobs data from a Source of your choice to Recruitee. -- ➑️ Push Profiles from a Source of your choice to Recruitee -- ⬅️ Pull Jobs from Recruitee to a Destination of your choice ## 🧠 Artificial Intelligence capabilities: +- Extract, Structure, and Categorize Talent & Workforce data +- Search, Score, and Match Profiles & Jobs with our APIs and AI Widgets (**Matching Custom Tab in Recruitee**) -- Easily Extract, Structure, and Categorize Talent & Workforce data -- Effortlessly Search, Score, and Match Profiles and Jobs with precision. # πŸ”Œ Connector Actions

@@ -59,8 +57,7 @@ This new connector will enable Recruitee customers & partners to:

-# 🐍 Quick Start Examples - +# πŸ’ Quick Start Examples To make sure you can successfully run the latest versions of the example scripts, you have to **install the package from PyPi**. To browse the examples of actions corresponding to released versions of πŸ€— this connector, you just need to import the module like this : @@ -72,16 +69,15 @@ To browse the examples of actions corresponding to released versions of πŸ€— thi Once the connector module is imported, you can leverage all the different actions that it offers. -For more code details checkout connector code +For more code details checkout connector code. # πŸ”— Useful Links -- πŸ“„Visit [Recruitee](https://Recruitee.com/) to learn more. +- πŸ“„Visit [Recruitee](https://recruitee.com/) to learn more. - βš™οΈ API documentation : [Recruitee API](https://api.recruitee.com/docs/index.html) - πŸ’» [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/recruitee) on our Github. # πŸ‘ Special Thanks -- πŸ’» HrFlow.ai : [Nedhir EBNOU](https://github.com/nedhirouebnou) - Software Engineer -- 🀝 Recruitee : **MengJia de Lange-Chen - Technical Partner Manager** and all the Recruitee team for their help and collaboration in building this integration - +- πŸ’» HrFlow.ai : [Nedhir Ebnou](https://github.com/itsnedhir) - Software Engineer +- 🀝 Tellent : **Nuno Sequeira & Diana De Freitas - Integrations Partners** for their help and collaboration in building this integration diff --git a/src/hrflow_connectors/v2/connectors/recruitee/connector.py b/src/hrflow_connectors/v2/connectors/recruitee/connector.py index dcb9c4bb..19e61539 100644 --- a/src/hrflow_connectors/v2/connectors/recruitee/connector.py +++ b/src/hrflow_connectors/v2/connectors/recruitee/connector.py @@ -261,14 +261,18 @@ def format_job(recruitee_job: t.Dict) -> t.Dict: return job +DESCRIPTION = ( + "Recruitee is an innovative and intuitive recruitment software that empowers" + " businesses to streamline hiring processes and attract top talent. Recruitee" + " provides a comprehensive solution that ensures a seamless and efficient" + " recruitment experience." +) + Recruitee = Connector( name="Recruitee", type=ConnectorType.ATS, subtype="recruitee", - description=( - "Collaborative hiring software and modern applicant tracking system with easy" - " setup, great UI, and top-rated customer support. " - ), + description=DESCRIPTION, url="https://recruitee.com/", warehouse=RecruiteeWarehouse, flows=( diff --git a/src/hrflow_connectors/v2/connectors/smartrecruiters/README.md b/src/hrflow_connectors/v2/connectors/smartrecruiters/README.md index 46180b52..e9d02e6b 100644 --- a/src/hrflow_connectors/v2/connectors/smartrecruiters/README.md +++ b/src/hrflow_connectors/v2/connectors/smartrecruiters/README.md @@ -1,19 +1,19 @@ # πŸ“– Summary -- [πŸ“– Summary](#-summary) -- [πŸ’Ό About SmartRecruiters](#-about-smartrecruiters) - - [😍 Why is it a big deal for SmartRecruiters customers \& partners?](#-why-is-it-a-big-deal-for-smartrecruiters-customers--partners) -- [πŸ”§ How does it work?](#-how-does-it-work) - - [πŸ“Š Data integration capabilities:](#-data-integration-capabilities) - - [🧠 Artificial Intelligence capabilities:](#-artificial-intelligence-capabilities) -- [πŸ”Œ Connector Actions](#-connector-actions) -- [🐍 Quick Start Examples](#-quick-start-examples) -- [πŸ”— Useful Links](#-useful-links) -- [πŸ‘ Special Thanks](#-special-thanks) +- [πŸ“– Summary](#πŸ“–-summary) +- [πŸ’Ό About Smartrecruiters](#πŸ’Ό-about-smartrecruiters) + - [😍 Why is it a big deal for Smartrecruiters customers & partners?](#😍-why-is-it-a-big-deal-for-smartrecruiters-customers--partners) +- [πŸ”§ How does it work?](#πŸ”§-how-does-it-work) + - [πŸ“Š Data integration capabilities:](#πŸ“Š-data-integration-capabilities) + - [🧠 Artificial Intelligence capabilities:](#🧠-artificial-intelligence-capabilities) +- [πŸ”Œ Connector Actions](#πŸ”Œ-connector-actions) +- [πŸ’ Quick Start Examples](#πŸ’-quick-start-examples) +- [πŸ”— Useful Links](#πŸ”—-useful-links) +- [πŸ‘ Special Thanks](#πŸ‘-special-thanks) -# πŸ’Ό About SmartRecruiters +# πŸ’Ό About Smartrecruiters -SmartRecruiters’ Talent Acquisition Suite is used by organizations to make the best hires. It has complete functionality for recruitment marketing and collaborative hiring built on a modern cloud platform with an open marketplace for 3rd party recruitment services. +> Move beyond applicant tracking systems (ATS) with an enterprise-grade recruiting platform designed for the modern workforce. SmartRecruiters' Talent Acquisition Suite provides everything needed to attract, select, and hire great talent.

@@ -23,24 +23,24 @@ SmartRecruiters’ Talent Acquisition Suite is used by organizations to make the

-## 😍 Why is it a big deal for SmartRecruiters customers & partners? +## 😍 Why is it a big deal for Smartrecruiters customers & partners? This new connector will enable: +- ⚑ A Fastlane Talent & Workforce data integration for Smartrecruiters customers & partners +- πŸ€– Cutting-edge AI-powered Talent Experiences & Recruiter Experiences for Smartrecruiters customers -- ⚑ A Fastlane Talent & Workforce data integration for SmartRecruiters customers & partners -- πŸ€– Cutting-edge AI-powered Talent Experiences & Recruiter Experiences for SmartRecruiters customers - -# πŸ”§ How does it work? - +# πŸ”§ How does it work? ## πŸ“Š Data integration capabilities: +- ⬅️ Send Profiles data from Smartrecruiters to a Destination of your choice. +- ➑️ Send Profiles data from a Source of your choice to Smartrecruiters. +- ⬅️ Send Jobs data from Smartrecruiters to a Destination of your choice. +- ➑️ Send Jobs data from a Source of your choice to Smartrecruiters. -- ➑️ Send Profiles data from a Source of your choice to SmartRecruiters -- ⬅️ Send Jobs data from SmartRecruiters to a Destination of your choice ## 🧠 Artificial Intelligence capabilities: - - Extract, Structure, and Categorize Talent & Workforce data -- Search, Score, and Match Profiles & Jobs with our APIs and AI Widgets +- Search, Score, and Match Profiles & Jobs with our APIs and AI Widgets (**Matching Custom Tab in Smartrecruiters**) + # πŸ”Œ Connector Actions

@@ -65,10 +65,11 @@ This new connector will enable:

-# 🐍 Quick Start Examples +# πŸ’ Quick Start Examples To make sure you can successfully run the latest versions of the example scripts, you have to **install the package from PyPi**. + To browse the examples of actions corresponding to released versions of πŸ€— this connector, you just need to import the module like this : @@ -78,8 +79,7 @@ To browse the examples of actions corresponding to released versions of πŸ€— thi Once the connector module is imported, you can leverage all the different actions that it offers. - -For more code details checkout connector code +For more code details checkout connector code. # πŸ”— Useful Links @@ -90,5 +90,5 @@ For more code details checkout connector code # πŸ‘ Special Thanks -- πŸ’» HrFlow.ai : [the-forest-tree](https://github.com/the-forest-tree) - Software Engineer +- πŸ’» HrFlow.ai : [the-forest-tree](https://github.com/the-forest-tree) - Software Engineer & [Nedhir Ebnou](https://github.com/itsnedhir) - Software Engineer - 🀝 [SmartRecruiters](https://www.smartrecruiters.com/) : Special thanks to the SmartRecruiters team for their help and collaboration in building this integrationn \ No newline at end of file diff --git a/src/hrflow_connectors/v2/connectors/zohorecruit/README.md b/src/hrflow_connectors/v2/connectors/zohorecruit/README.md index 7b17e0de..6b13759f 100644 --- a/src/hrflow_connectors/v2/connectors/zohorecruit/README.md +++ b/src/hrflow_connectors/v2/connectors/zohorecruit/README.md @@ -53,6 +53,11 @@ This new connector will enable:

+

+ +

+ # πŸ’ Quick Start Examples @@ -61,6 +66,10 @@ To make sure you can successfully run the latest versions of the example scripts To browse the examples of actions corresponding to released versions of πŸ€— this connector, you just need to import the module like this : +

+ +

Once the connector module is imported, you can leverage all the different actions that it offers. @@ -75,4 +84,4 @@ For more code details checkout connector code. # πŸ‘ Special Thanks -- πŸ’» HrFlow.ai : Nedhir Ebnou - Software Engineer +- πŸ’» HrFlow.ai : [Nedhir Ebnou](https://github.com/itsnedhir) - Software Engineer