The Rhumbix DataLoader provides a basic utility to import data into your Rhumbix account. It reads in csv files from the `csv_directory` provided in the invocation, and updates or inserts the data to the Rhumbix company identified.
There are three types of Rhumbix data that can be imported, Projects, Cost Codes, and Worker information. Each data has different required fields and identifiers that roughly follow the csv templates provided by Rhumbix.
This utility requires a Rhumbix account and access to the API. The Rhumbix company is authenticated through the public API the `company_key` and `api_key`. More documentation on the Public API can be found at http://docs.rhumbix.com/
## Setup
```
pip install rhumbix_csv_processor
```
## Usage
### Process CSV directory
The script can be invoked as follows:
`rhumbix_csv_uploader csv_directory company_key api_key`
This will process files matching `rhumbix_employee*.csv` as employee files, `rhumbix_project*.csv` as project files, and `rhumbix_cost_code*.csv` as the cost code files.
Optionally, you may provide a `config.json` in your current directory with any of the following parameters:
```json
{
"company_key" : "YOUR_COMPANY_KEY",
"api_key" : "YOUR_API_KEY",
"employee_filename_pattern" : "YOUR_EMPLOYEE_FILENAME_REGEX",
"project_filename_pattern" : "YOUR_PROJECT_FILENAME_REGEX",
"cost_code_filename_pattern" : "YOUR_COSTCODE_FILENAME_REGEX"
}
```
### Employee CSV
#### File Format
The employee processor expects a csv file with no headers and columns formatted in the following order:
`company_supplied_id, first_name, last_name, classification-role, trade, is_active`
### Project CSV
#### File Format
The project processor expects a csv file with no headers. the `Customer Number` is currently not used in Rhumbix. The columns are formatted in the following order:
`job_number, Customer Number - unused, name, is_active`
### Cost Code CSV
#### File Format
The cost code processor expects a csv file with no headers. The `phase` is concatenated with the `cost_code` inside the Rhumbix system. The columns are formatted in the following order:
`job_number, name, cost_code, phase, description`
### Direct Usage
If desired, the individual loaders can be called directly with the following format.
```python
from rhumbix_csv_uploader import employee_processor
employee_processor.process_csv("rhumbix_csv_uploader/test/exampleCSVs/rhumbix_payroll.csv", COMPANY_KEY, API_KEY)
```
```python
from rhumbix_csv_uploader import project_processor
project_processor.process_csv("rhumbix_csv_uploader/test/exampleCSVs/rhumbix_wo.csv", COMPANY_KEY, API_KEY)
```
```python
from rhumbix_csv_uploader import cost_code_processor
cost_code_processor.process_csv("rhumbix_csv_uploader/test/exampleCSVs/rhumbix_job_cost_2.csv", COMPANY_KEY, API_KEY)
```
Metadata
Release files for rhumbix-csv-uploader 0.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| rhumbix_csv_uploader-0.0.4.tar.gz | 10.4 kB | Without provenance | Details |
Release files / rhumbix_csv_uploader-0.0.4.tar.gz
| Download URL | rhumbix_csv_uploader-0.0.4.tar.gz |
|---|---|
| Size | 10.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8d19839ab2d2adf53fbe54ddc65e32ae82827526ef28caf09f770267a877c3d7
|
|
BLAKE2b-256 checksum How to use checksums |
7fa823577139883bbc25649dcdf02b8c22c367bc309c69a4739f82750a53e615
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for rhumbix-csv-uploader 0.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.