Skip to content

Commit

Permalink
Merge pull request #306 from Riminder/fix/documentations-graphs
Browse files Browse the repository at this point in the history
update: connectors' documentations with data flows and import graph
  • Loading branch information
Thomas65535 authored Dec 3, 2024
2 parents 78889fc + f93cc43 commit 3b72be1
Show file tree
Hide file tree
Showing 8 changed files with 111 additions and 75 deletions.
21 changes: 16 additions & 5 deletions src/hrflow_connectors/v2/connectors/admen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.



Expand Down Expand Up @@ -56,6 +56,12 @@ This new connector will enable:

</p>

</p>

<p align="center">
<image src=https://github.com/user-attachments/assets/cac7da42-2146-4e67-ac8c-7e37f4550554 width=90% height=100%
>
</p>
# 💍 Quick Start Examples

Expand All @@ -65,17 +71,22 @@ 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 :


<p align="center">
<image src=https://github.com/user-attachments/assets/2dead632-4543-4be3-bc6d-d85a49bc31d0 width=90% height=100%
>
</p>
Once the connector module is imported, you can leverage all the different actions that it offers.

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
- 💻 HrFlow.ai : [Nedhir Ebnou](https://github.com/itsnedhir) - Software Engineer
- 🤝 Inasoft : Aurélie CARLESCHI - Operations Director
4 changes: 2 additions & 2 deletions src/hrflow_connectors/v2/connectors/admen/connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
20 changes: 18 additions & 2 deletions src/hrflow_connectors/v2/connectors/bullhorn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@

> Transform Your Business with Bullhorn Staffing and Recruitment Software
<p align="center">
<image src=https://user-images.githubusercontent.com/57711045/216124159-5bf2ff28-66a7-4327-ba1d-e417748d4ab5.png width=90% height=100% >
</p>

<p align="center">
<image src=https://user-images.githubusercontent.com/57711045/216124837-d8dd8f03-dae5-4298-ba57-cef2c00df4dd.png width=90% height=100% >
</p>

## 😍 Why is it a big deal for Bullhorn customers & partners?

Expand All @@ -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.

<p align="center">
<image src=https://github.com/Riminder/hrflow-connectors/assets/57711045/9dc5543c-5507-4317-ad23-c1702153a972 width=90% height=100% >
</p>

## 🧠 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**)

<p align="center">
<image src=https://user-images.githubusercontent.com/57711045/217298819-29d43799-422d-48f4-8995-272d0af66cbe.gif width=90% height=100% >
</p>

# 🔌 Connector Actions
<p align="center">
Expand All @@ -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 :

<p align="center">
<image src=https://user-images.githubusercontent.com/57711045/216126235-03319722-c10b-460d-b19d-0e4240fe652c.png width=90% height=100% >
</p>

Once the connector module is imported, you can leverage all the different actions that it offers.

Expand All @@ -71,5 +87,5 @@ For more code details checkout connector code.


# 👏 Special Thanks
- 💻 HrFlow.ai : XXXXX YYYYY - Software Engineer
- 🤝 Bullhorn : XXXXX YYYYY - Partner Manager
- 💻 HrFlow.ai : [Nedhir Ebnou](https://github.com/itsnedhir) - Software Engineer & Abdellahi Mezid - Software Engineer
- 🤝 Bullhorn : Arne LOOTEN - Partner Manager
4 changes: 2 additions & 2 deletions src/hrflow_connectors/v2/connectors/hubspot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ In this section, we outline the data flow between different components of the co
</p>


# 🐍 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**.
Expand All @@ -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)

62 changes: 29 additions & 33 deletions src/hrflow_connectors/v2/connectors/recruitee/README.md
Original file line number Diff line number Diff line change
@@ -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.

<p align="center">
<image src=https://github.com/Riminder/hrflow-connectors/assets/57711045/3457716c-0c60-4db3-8f6d-78c6a42b9923 width=90% height=100% >
</p>

# 😍 **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
<p align="center">
Expand All @@ -59,8 +57,7 @@ This new connector will enable Recruitee customers & partners to:
<image src=https://github.com/Riminder/hrflow-connectors/assets/57711045/ff726feb-d580-40f8-82b2-6c1132cebd8e width=90% height=100% >
</p>

# 🐍 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 :
Expand All @@ -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
12 changes: 8 additions & 4 deletions src/hrflow_connectors/v2/connectors/recruitee/connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -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=(
Expand Down
52 changes: 26 additions & 26 deletions src/hrflow_connectors/v2/connectors/smartrecruiters/README.md
Original file line number Diff line number Diff line change
@@ -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.
<p align="center">
<image src=https://user-images.githubusercontent.com/57711045/214608440-2d838ca1-cdd9-49ca-ac3b-25d65f06994a.png width=90% height=100% >
Expand All @@ -23,24 +23,24 @@ SmartRecruiters’ Talent Acquisition Suite is used by organizations to make the
<image src=https://user-images.githubusercontent.com/57711045/214608101-4a496152-8aec-4528-afd0-b0712f9c5010.png width=90% height=100% >
</p>

## 😍 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
<p align="center">
Expand All @@ -65,10 +65,11 @@ This new connector will enable:
</p>


# 🐍 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 :


Expand All @@ -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
Expand All @@ -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
11 changes: 10 additions & 1 deletion src/hrflow_connectors/v2/connectors/zohorecruit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ This new connector will enable:

</p>

<p align="center">
<image src=https://github.com/user-attachments/assets/0c646581-8bce-4e54-b52d-a20353fc459c width=90% height=100%
>
</p>

# 💍 Quick Start Examples

Expand All @@ -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 :

<p align="center">
<image src=https://github.com/user-attachments/assets/4b16200f-81e2-4766-8f2d-b2ee8bd5e470 width=90% height=100%
>
</p>
Once the connector module is imported, you can leverage all the different actions that it offers.

Expand All @@ -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

0 comments on commit 3b72be1

Please sign in to comment.