-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature: Add Breezy HR Connector in CRUD v2
- Loading branch information
1 parent
48c57c4
commit eb4d294
Showing
22 changed files
with
1,943 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
# 📖 Summary | ||
- [📖 Summary](#-summary) | ||
- [📝 About BreezyHR](#-about-breezyhr) | ||
- [📊 Data Flow](#-data-flow) | ||
- [🔌 Connector Actions](#-connector-actions) | ||
- [🐍 Quick Start Examples](#-quick-start-examples) | ||
- [**Push Profiles Action**](#push-profiles-action) | ||
- [**Pull Jobs Action**](#pull-jobs-action) | ||
- [🔗 Useful Links](#-useful-links) | ||
- [👏 Special Thanks](#-special-thanks) | ||
|
||
|
||
# 📝 About BreezyHR | ||
|
||
BreezyHr is a software designed to assist teams in finding the right candidates, evaluating applicants, and making a hire more quickly. | ||
It helps streamline the recruitment process and identify the best fit for a position. | ||
|
||
|
||
<p align="center"> | ||
<image src=https://user-images.githubusercontent.com/55802491/212358414-f29104b6-c54b-4f91-b376-1fe7b5fb8eb1.png width=90% height=100% > | ||
</p> | ||
|
||
# 📊 Data Flow | ||
In this section, we outline the data flow between different components of the connector. The following schema provides a graphical representation of the data exchange process | ||
|
||
<p align="center"> | ||
<image src=https://user-images.githubusercontent.com/55802491/212667728-8a1d7eab-04b0-453b-9381-444ff47751cd.jpg width=90% height=100% > | ||
</p> | ||
|
||
# 🔌 Connector Actions | ||
<p align="center"> | ||
|
||
| Action | Description | | ||
| ------- | ----------- | | ||
| [**Pull job list**](docs/pull_job_list.md) | Retrieves all jobs via the ***BreezyHR*** API and send them to a ***Hrflow.ai Board***. | | ||
| [**Push profile list**](docs/push_profile_list.md) | Push all profiles from ***Hrflow.ai Source*** via ***BreezyHR*** API and send them to a ***BreezyHR***. | | ||
| [**Pull profile list**](docs/pull_profile_list.md) | Retrieves all profiles via the ***BreezyHR*** API and send them to a ***Hrflow.ai Source***. | | ||
|
||
|
||
</p> | ||
|
||
|
||
# 🐍 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 : | ||
|
||
|
||
<p align="center"> | ||
<image src=https://user-images.githubusercontent.com/107410704/219009142-9fd3c7f5-97f5-43a9-b7af-0f358fa28bd5.png 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 [BreezyHR](https://breezy.hr/) to learn more. | ||
- ⚙️ API documentation : (https://developer.breezy.hr/reference/overview) | ||
- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/breezyhr) on our Github. | ||
|
||
|
||
# 👏 Special Thanks | ||
- 💻 HrFlow.ai : [Limam VADHEL](https://github.com/limamvadhel) - Software Engineer | ||
- 💻 HrFlow.ai : [Leo FERRETTI](https://github.com/Sprenger07) - Software Engineer | ||
- 💻 HrFlow.ai :[Corentin DUCHENE](https://github.com/CorentinDuchene) - Software Engineer | ||
- 💻 HrFlow.ai : [Nedhir Ebnou](https://github.com/nedhirouebnou) - Software Engineer | ||
- 🤝 BreezyHR :[Breezy HR for the partnership and accessible documentation](https://breezy.hr/) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
from hrflow_connectors.v2.connectors.breezyhr.connector import BreezyHR # noqa |
Oops, something went wrong.