Giter VIP home page Giter VIP logo

wellsouth-project's Introduction

wellsouth-project

This project connects Wellsouth's BambooHR database and Power Automate through an intermediary program, nicknamed "bampower".

Installation

  1. Clone this repository
  2. Install poetry (it's recommended that you use pipx to install)
  3. Create and activate a python virtual environment
  4. Install packages with poetry install
  5. Rename .env.example to .env, and fill out the fields. "API_KEY" is your BambooHR API key, and "DOMAIN" is the name of your BambooHR instance (DOMAIN.bamboohr.com). If you want to enable email error reporting, fill out "EMAIL_ADDRESSES", "EMAIL_PASSWORD", and "RECEIVING_ADDRESSES".
  6. Configure watching.json (stored in files directory)

Usage

python3 bampower

This will create a new snapshot folder under files/snapshots/, stamped with the current time. Bampower will then use watching.json to generate multiple reports. Each report will be saved as a JSON file within the current snapshot folder and sent to its specified URL endpoint.

Configuration

Bampower is configured via watching.json, like so:

[
    {
        "title": "updated_job_title",
        "sendToEndpoint": "example.com",
        "fields": [
            {
                "id": 17,
                "name": "Job Title",
                "type": "list",
                "alias": "jobTitle"
            }
        ]
    }
]

This will create one snapshot file named updated_job_title.json

While the only neccessary field is id, adding the others is recommended, as it increases readability.

Fields that can be added are found in the metafields.json file, which will be created when bampower is initially run.

Troubleshooting

Every time bampower runs, a log.txt file is saved to the current snapshot folder, or to files/log.txt if the program fails. This may help with troubleshooting.

wellsouth-project's People

Contributors

ethanleitch avatar dependabot[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.