Added Personio documentation. #798
Conversation
✅ Deploy Preview for dlt-hub-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| Personio is a human resources management software that helps businesses streamline HR processes, | ||
| including recruitment, employee data management, and payroll, in one platform. | ||
|
|
||
| Our Personio verified source loads data using Perosnio API to your preferred |
There was a problem hiding this comment.
link Personio verified source to https://github.com/dlt-hub/verified-sources/blob/master/sources/personio
|
|
||
| ### Grab credentials | ||
|
|
||
| To load data from Personio, you need to API credentials, `client_id` and `client_secret`: |
There was a problem hiding this comment.
i think you missed something "you need to ... (what to do?) ... API"
|
|
||
| ### Source `personio_source` | ||
|
|
||
| This function initializes class `PersonioAPI` in "personio/helpers.py" and returns data resources |
There was a problem hiding this comment.
rephrase it as "This dlt source returns data resources like ..."
| 1. Sign in to your Personio account, and ensure that your user account has API access rights. | ||
| 1. Navigate to Settings > Integrations > API credentials. | ||
| 1. Click on "Generate new credentials." | ||
| 1. Assign necessary permissions to credentials, i.e. read access. |
There was a problem hiding this comment.
add the Note at the end:
:::info
The Personio UI, which is described here, might change. The full guide is available at this link.
:::
| configuration settings to get started. | ||
|
|
||
| For more information, read the | ||
| [Walkthrough: Add a verified source.](../../walkthroughs/add-a-verified-source) |
There was a problem hiding this comment.
we periodically reorganize docs structure, so we don't have Walkthrough section anymore, we need to replace it with something neutral, at least:
For more information, read Add a verified source.
| your chosen destination. This will ensure that your data is properly routed to its final | ||
| destination. | ||
|
|
||
| For more information, read the [General Usage: Credentials.](../../general-usage/credentials) |
There was a problem hiding this comment.
we periodically reorganize docs structure, so we don't have General Usage section anymore, we need to replace it with something neutral, at least:
For more information, read Credentials..
| For example, the `pipeline_name` for the above pipeline example is `personio`, you may also use | ||
| any custom name instead. | ||
|
|
||
| For more information, read the [Walkthrough: Run a pipeline.](../../walkthroughs/run-a-pipeline) |
There was a problem hiding this comment.
we periodically reorganize docs structure, so we don't have Walkthrough section anymore, we need to replace it with something neutral, at least:
For more information, read Run a pipeline.
| ) | ||
| ``` | ||
|
|
||
| :::note |
There was a problem hiding this comment.
raplace the whole note with one link to pipeline:
Configure the pipeline by specifying the pipeline name, destination, and dataset as follows:
| print(pipeline.run(load_data)) | ||
| ``` | ||
|
|
||
| 1. To load data from all supported endpoints: |
There was a problem hiding this comment.
to load all supported endpoints:
load_data = personio_source()
print(pipeline.run(load_data))|
|
||
| ```python | ||
| load_data = personio_source().with_resources("employees", "absences", "attendances") | ||
| print(pipeline.run(load_data)) |
There was a problem hiding this comment.
can you please add one more example:
how to use start_date and end_date for attendances resource https://github.com/dlt-hub/verified-sources/blob/master/sources/personio/__init__.py#L100-L111
There was a problem hiding this comment.
as discussed, let's skip for now. Will update later.
Description
Added Personio documentation.
Related Issues
Additional Context