| Name | factorialhr JSON |
| Version |
3.0.0
JSON |
| download |
| home_page | None |
| Summary | Python package for the api of FactorialHR |
| upload_time | 2025-02-11 11:45:16 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.14,>=3.11 |
| license | None |
| 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/
## Usage
Get all employees
```python
import factorialhr
from factorialhr.endpoints import employees
authorizer = factorialhr.ApiKeyAuth('<api_key>') # checkout other authorization methods
async with factorialhr.ApiClient(authorizer) as api:
employee_endpoint = employees.Employee(api)
all_employees = await employee_endpoint.all()
```
Get a dictionary with team id as key and a list of member as value
```python
import asyncio
import factorialhr
from factorialhr.endpoints import employees, teams
authorizer = factorialhr.AccessTokenAuth('<access_token>') # checkout other authorization methods
async with factorialhr.ApiClient(authorizer) as api:
employees_endpoint = employees.Employee(api)
teams_endpoint = teams.Team(api)
all_employees, all_teams = await asyncio.gather(employees_endpoint.all(), teams_endpoint.all())
employees_by_team_id = {team['id']: [employee['id'] for employee in all_employees['data']] for team in all_teams['data']}
```
## Implemented endpoints for api version 2025-01-01
- [x] ApiPublic
- [x] Ats
- [x] Attendance
- [ ] BookkeepersManagement
- [ ] Companies
- [ ] Contracts
- [ ] CustomFields
- [ ] CustomResources
- [ ] Documents
- [x] Employees
- [ ] EmployeeUpdates
- [ ] Expenses
- [ ] Finance
- [ ] Holidays
- [ ] JobCatalog
- [ ] Locations
- [ ] Marketplace
- [ ] Payroll
- [ ] PayrollEmployees
- [ ] PayrollIntegrationBase
- [ ] Performance
- [ ] Posts
- [x] ProjectManagement
- [ ] ShiftManagement
- [ ] Tasks
- [x] Teams
- [ ] Timeoff
- [ ] TimePlanning
- [ ] TimeSettings
- [ ] Trainings
- [ ] WorkSchedule
- [ ] Webhooks
## Contribute
Feel free to contribute! Please fork this repository, install the development dependencies with `uv sync --dev`
and create pull request.
Raw data
{
"_id": null,
"home_page": null,
"name": "factorialhr",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.11",
"maintainer_email": null,
"keywords": "FactorialHR, HR",
"author": null,
"author_email": "Leon Budnick <y6q6ea9w@mail-proxy.org>",
"download_url": "https://files.pythonhosted.org/packages/2f/ac/a73d94ce14e604c23c932edda90d268ce0e2f43f674efcc5dcd4aea4d0a1/factorialhr-3.0.0.tar.gz",
"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\n## Usage\n\nGet all employees\n```python\nimport factorialhr\nfrom factorialhr.endpoints import employees\n\nauthorizer = factorialhr.ApiKeyAuth('<api_key>') # checkout other authorization methods\nasync with factorialhr.ApiClient(authorizer) as api:\n employee_endpoint = employees.Employee(api)\n all_employees = await employee_endpoint.all()\n```\nGet a dictionary with team id as key and a list of member as value\n```python\nimport asyncio\n\nimport factorialhr\nfrom factorialhr.endpoints import employees, teams\n\nauthorizer = factorialhr.AccessTokenAuth('<access_token>') # checkout other authorization methods\nasync with factorialhr.ApiClient(authorizer) as api:\n employees_endpoint = employees.Employee(api)\n teams_endpoint = teams.Team(api)\n all_employees, all_teams = await asyncio.gather(employees_endpoint.all(), teams_endpoint.all())\n employees_by_team_id = {team['id']: [employee['id'] for employee in all_employees['data']] for team in all_teams['data']}\n```\n\n## Implemented endpoints for api version 2025-01-01\n\n- [x] ApiPublic\n- [x] Ats\n- [x] Attendance\n- [ ] BookkeepersManagement\n- [ ] Companies\n- [ ] Contracts\n- [ ] CustomFields\n- [ ] CustomResources\n- [ ] Documents\n- [x] Employees\n- [ ] EmployeeUpdates\n- [ ] Expenses\n- [ ] Finance\n- [ ] Holidays\n- [ ] JobCatalog\n- [ ] Locations\n- [ ] Marketplace\n- [ ] Payroll\n- [ ] PayrollEmployees\n- [ ] PayrollIntegrationBase\n- [ ] Performance\n- [ ] Posts\n- [x] ProjectManagement\n- [ ] ShiftManagement\n- [ ] Tasks\n- [x] Teams\n- [ ] Timeoff\n- [ ] TimePlanning\n- [ ] TimeSettings\n- [ ] Trainings\n- [ ] WorkSchedule\n- [ ] Webhooks\n\n## Contribute\n\nFeel free to contribute! Please fork this repository, install the development dependencies with `uv sync --dev`\nand create pull request.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python package for the api of FactorialHR",
"version": "3.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/leon1995/factorialhr/issues",
"Repository": "https://github.com/leon1995/factorialhr"
},
"split_keywords": [
"factorialhr",
" hr"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b59717056d23f640384db1bd6f71202b8d50a95a44cce136826fd15b27fec1cd",
"md5": "8cf2a5f913861b1c25f2484a793bf962",
"sha256": "a2bed4a8f707f17f242af072ccd7119fea3518cdc5ac664f78a6654137e20af1"
},
"downloads": -1,
"filename": "factorialhr-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8cf2a5f913861b1c25f2484a793bf962",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.11",
"size": 26855,
"upload_time": "2025-02-11T11:45:13",
"upload_time_iso_8601": "2025-02-11T11:45:13.412157Z",
"url": "https://files.pythonhosted.org/packages/b5/97/17056d23f640384db1bd6f71202b8d50a95a44cce136826fd15b27fec1cd/factorialhr-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2faca73d94ce14e604c23c932edda90d268ce0e2f43f674efcc5dcd4aea4d0a1",
"md5": "eb7bad50ed38eccdb55bee76cabfedce",
"sha256": "a68fd229f43478d7592b1df7f69f2d15d2ad804d67051a96c6903e271ff7f5f4"
},
"downloads": -1,
"filename": "factorialhr-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "eb7bad50ed38eccdb55bee76cabfedce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.11",
"size": 19874,
"upload_time": "2025-02-11T11:45:16",
"upload_time_iso_8601": "2025-02-11T11:45:16.328506Z",
"url": "https://files.pythonhosted.org/packages/2f/ac/a73d94ce14e604c23c932edda90d268ce0e2f43f674efcc5dcd4aea4d0a1/factorialhr-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-11 11:45:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "leon1995",
"github_project": "factorialhr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "factorialhr"
}
