| Name | factorialhr JSON |
| Version |
2.0.0
JSON |
| download |
| home_page | |
| Summary | Python package for the api of FactorialHR |
| upload_time | 2023-10-06 14:20:11 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.11 |
| license | |
| keywords |
factorialhr
hr
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# FactorialHR api python wrapper
This package provides a python wrapper to the [api of FactorialHR](https://apidoc.factorialhr.com/docs).
## Disclaimer
I am not affiliated, associated, authorized, endorsed by, or in any way officially connected with EVERYDAY SOFTWARE, S.L. or FactorialHR, or any of its subsidiaries or its affiliates. The official factorialhr.com website can be found at https://factorialhr.com/
Unfortunately, the documentation is not detailed and updated, such that many parameters have been reverse engineered and
may be wrong or change at any time. If you encounter some
problems, [open an issue](https://github.com/leon1995/factorialhr/issues) or [contribute](#Contribute) the fix yourself.
## Usage
Get all employees
```python
from factorialhr import endpoints
async with endpoints.NetworkHandler as api:
endpoint = endpoints.EmployeesEndpoint(api)
all_employees = await endpoint.all()
```
Get a dictionary with team id as key and a list of member as value
```python
from factorialhr import endpoints
from factorialhr import models
async with endpoints.NetworkHandler('<api_key>') as api:
e_endpoint = endpoints.EmployeesEndpoint(api)
t_endpoint = endpoints.TeamsEndpoint(api)
all_employees = await e_endpoint.all()
all_teams = await t_endpoint.all()
employees_by_team_id: dict[int, models.Employee] = {team.id: [e for e in all_employees
if e.id in team.employee_ids] for team in all_teams}
```
## TODO
- [ ] tests
- [ ] oauth2 support
- [ ] [Family situation endpoint](https://apidoc.factorialhr.com/reference/get_v1-payroll-family-situation)
- [ ] [Contract versions endpoint](https://apidoc.factorialhr.com/reference/get_v1-payroll-contract-versions)
- [ ] [Supplements endpoint](https://apidoc.factorialhr.com/reference/get_v1-payroll-supplements)
- [ ] [Shift management endpoint](https://apidoc.factorialhr.com/reference/get_v1-time-shifts-management)
- [ ] [Breaks endpoint](https://apidoc.factorialhr.com/reference/post_v1-time-breaks-start)
- [ ] [Application endpoint](https://apidoc.factorialhr.com/reference/post_v1-ats-applications)
- [ ] [ATS messages endpoint](https://apidoc.factorialhr.com/reference/get_v1-ats-messages)
- [ ] [Expenses endpoint](https://apidoc.factorialhr.com/reference/get_v1-finance-expenses)
- [ ] [Get Custom Table Fields](https://apidoc.factorialhr.com/reference/get_v1-core-custom-tables-id-values-employee-id)
- [ ] [Creates a custom table value](https://apidoc.factorialhr.com/reference/post_v1-core-custom-tables-id-values-employee-id)
## Contribute
Feel free to contribute! Please fork this repository, install the development dependencies with `pip install -e ".[dev]"`
and create pull request.
Raw data
{
"_id": null,
"home_page": "",
"name": "factorialhr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "FactorialHR,HR",
"author": "",
"author_email": "Leon Budnick <y6q6ea9w@mail-proxy.org>",
"download_url": "",
"platform": null,
"description": "# FactorialHR api python wrapper\n\nThis package provides a python wrapper to the [api of FactorialHR](https://apidoc.factorialhr.com/docs).\n\n## Disclaimer\n\nI am not affiliated, associated, authorized, endorsed by, or in any way officially connected with EVERYDAY SOFTWARE, S.L. or FactorialHR, or any of its subsidiaries or its affiliates. The official factorialhr.com website can be found at https://factorialhr.com/\n\nUnfortunately, the documentation is not detailed and updated, such that many parameters have been reverse engineered and\nmay be wrong or change at any time. If you encounter some\nproblems, [open an issue](https://github.com/leon1995/factorialhr/issues) or [contribute](#Contribute) the fix yourself.\n\n## Usage\n\nGet all employees\n```python\nfrom factorialhr import endpoints\n\nasync with endpoints.NetworkHandler as api:\n endpoint = endpoints.EmployeesEndpoint(api)\n all_employees = await endpoint.all()\n```\nGet a dictionary with team id as key and a list of member as value\n```python\nfrom factorialhr import endpoints\nfrom factorialhr import models\n\nasync with endpoints.NetworkHandler('<api_key>') as api:\n e_endpoint = endpoints.EmployeesEndpoint(api)\n t_endpoint = endpoints.TeamsEndpoint(api)\n all_employees = await e_endpoint.all()\n all_teams = await t_endpoint.all()\n employees_by_team_id: dict[int, models.Employee] = {team.id: [e for e in all_employees\n if e.id in team.employee_ids] for team in all_teams}\n```\n\n## TODO\n\n- [ ] tests\n- [ ] oauth2 support\n- [ ] [Family situation endpoint](https://apidoc.factorialhr.com/reference/get_v1-payroll-family-situation)\n- [ ] [Contract versions endpoint](https://apidoc.factorialhr.com/reference/get_v1-payroll-contract-versions)\n- [ ] [Supplements endpoint](https://apidoc.factorialhr.com/reference/get_v1-payroll-supplements)\n- [ ] [Shift management endpoint](https://apidoc.factorialhr.com/reference/get_v1-time-shifts-management)\n- [ ] [Breaks endpoint](https://apidoc.factorialhr.com/reference/post_v1-time-breaks-start)\n- [ ] [Application endpoint](https://apidoc.factorialhr.com/reference/post_v1-ats-applications)\n- [ ] [ATS messages endpoint](https://apidoc.factorialhr.com/reference/get_v1-ats-messages)\n- [ ] [Expenses endpoint](https://apidoc.factorialhr.com/reference/get_v1-finance-expenses)\n- [ ] [Get Custom Table Fields](https://apidoc.factorialhr.com/reference/get_v1-core-custom-tables-id-values-employee-id)\n- [ ] [Creates a custom table value](https://apidoc.factorialhr.com/reference/post_v1-core-custom-tables-id-values-employee-id)\n\n## Contribute\n\nFeel free to contribute! Please fork this repository, install the development dependencies with `pip install -e \".[dev]\"`\nand create pull request.\n",
"bugtrack_url": null,
"license": "",
"summary": "Python package for the api of FactorialHR",
"version": "2.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/leon1995/factorialhr/issues",
"Homepage": "https://github.com/leon1995/factorialhr"
},
"split_keywords": [
"factorialhr",
"hr"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a1118394c585c843f86c26c1580c3b17bbf5ba34fddbfb28e22fd2a204b07302",
"md5": "2c444ae408cc9688313bf1f59a7d0290",
"sha256": "f0cf492a17f7744225aa200035500bc4299602a6403c3b56e9941cb3433ab48d"
},
"downloads": -1,
"filename": "factorialhr-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2c444ae408cc9688313bf1f59a7d0290",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 8884,
"upload_time": "2023-10-06T14:20:11",
"upload_time_iso_8601": "2023-10-06T14:20:11.946837Z",
"url": "https://files.pythonhosted.org/packages/a1/11/8394c585c843f86c26c1580c3b17bbf5ba34fddbfb28e22fd2a204b07302/factorialhr-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-06 14:20:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "leon1995",
"github_project": "factorialhr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "factorialhr"
}
