{
    "info": {
        "author": "David Wallace",
        "author_email": "david.wallace@goodeggs.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 1 - Planning",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
            "Natural Language :: English",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Programming Language :: Python :: 3 :: Only",
            "Topic :: Software Development"
        ],
        "description": "# tap-dayforce\n[![PyPI version](https://badge.fury.io/py/tap-dayforce.svg)](https://badge.fury.io/py/tap-dayforce)\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![Python Versions](https://img.shields.io/badge/python-3.6%20%7C%203.7-blue.svg)](https://pypi.python.org/pypi/ansicolortags/)\n[![Build Status](https://travis-ci.com/goodeggs/tap-pagerduty.svg?branch=master)](https://travis-ci.com/goodeggs/tap-dayforce.svg?branch=master)\n\nA [Singer](https://www.singer.io/) tap for extracting data from the [Dayforce REST API v1](https://developers.dayforce.com/Build/RESTful-general-URL-structure.aspx).\n\n## Installation\n\nSince package dependencies tend to conflict between various taps and targets, Singer [recommends](https://github.com/singer-io/getting-started/blob/master/docs/RUNNING_AND_DEVELOPING.md#running-singer-with-python) installing taps and targets into their own isolated virtual environments:\n\n### Install Dayforce Tap\n\n```bash\n$ python3 -m venv ~/.venvs/tap-dayforce\n$ source ~/.venvs/tap-dayforce/bin/activate\n$ pip3 install tap-dayforce\n$ deactivate\n```\n\n### Install Stitch Target (optional)\n\n```bash\n$ python3 -m venv ~/.venvs/target-stitch\n$ source ~/.venvs/target-stitch/bin/activate\n$ pip3 install target-stitch\n$ deactivate\n```\n\n## Configuration\n\nThe tap accepts a JSON-formatted configuration file as arguments. This configuration file has four required fields:\n\n1. `username`: A valid Dayforce web services user account username.\n2. `password`: A valid Dayforce web services user account password.\n3. `client_name`: A valid client name (e.g. Company Name) that will be inserted into the request URL.\n2. `email`: A valid email address to be inserted into the `From` header of the HTTP Request headers.\n\nIt's important to note that the Role attached to the User Account used in the configuration file must have at minimum the \"Web Services\" feature, as well as the \"Read Data\" sub-feature enabled.\n\nAn bare-bones Dayforce configuration may file may look like the following:\n\n```json\n{\n  \"username\": \"foo\",\n  \"password\": \"bar\",\n  \"client_name\": \"foo_bar\",\n  \"email\": \"foo.bar@gmail.com\"\n}\n```\n\nAdditionally, you may specify more granular configurations for individual streams. Each key under a stream should represent a valid API request parameter for that endpoint. A more fleshed-out configuration file may look similar to the following:\n\n```json\n{\n  \"username\": \"foo\",\n  \"password\": \"bar\",\n  \"client_name\": \"foo_bar\",\n  \"email\": \"foo.bar@gmail.com\",\n  \"streams\": {\n    \"employees\": {\n      \"expand\": \"EmploymentStatuses,Roles,EmployeeManagers,CompensationSummary,Locations,LastActiveManagers\"\n    },\n    \"employee_punches\": {\n      \"filterTransactionStartTimeUTC\": \"2019-06-01T00:00:00Z\"\n    }\n  }\n}\n```\n\n## Streams\n\nThe current version of the tap syncs two distinct [Streams](https://github.com/singer-io/getting-started/blob/master/docs/SYNC_MODE.md#streams):\n1. `Employees`: [Endpoint Documentation](https://developers.dayforce.com/Build/API-Explorer/Employee/GET-Employee-Details.aspx)\n2. `EmployeePunches`: [Endpoint Documentation](https://developers.dayforce.com/Build/API-Explorer/Time-Management/Employee-Punches.aspx)\n\n## Discovery\n\nSinger taps describe the data that a stream supports via a [Discovery](https://github.com/singer-io/getting-started/blob/master/docs/DISCOVERY_MODE.md#discovery-mode) process. You can run the Dayforce tap in Discovery mode by passing the `--discover` flag at runtime:\n\n```bash\n$ ~/.venvs/tap-dayforce/bin/tap-dayforce --config=config/dayforce.config.json --discover\n```\n\nThe tap will generate a [Catalog](https://github.com/singer-io/getting-started/blob/master/docs/DISCOVERY_MODE.md#the-catalog) to stdout. To pass the Catalog to a file instead, simply redirect it to a file:\n\n```bash\n$ ~/.venvs/tap-dayforce/bin/tap-dayforce --config=config/dayforce.config.json --discover > catalog.json\n```\n\n## Sync to stdout\n\nRunning a tap in [Sync mode](https://github.com/singer-io/getting-started/blob/master/docs/SYNC_MODE.md#sync-mode) will extract data from the various selected Streams. In order to run a tap in Sync mode and have messages emitted to stdout, pass a valid configuration file and catalog file:\n\n```bash\n$ ~/.venvs/tap-dayforce/bin/tap-dayforce --config=config/dayforce.config.json --catalog=catalog.json\n```\n\nThe tap will emit occasional [Metric](https://github.com/singer-io/getting-started/blob/master/docs/SYNC_MODE.md#metric-messages), [Schema](https://github.com/singer-io/getting-started/blob/master/docs/SPEC.md#schema-message), [Record](https://github.com/singer-io/getting-started/blob/master/docs/SPEC.md#record-message), and [State messages](https://github.com/singer-io/getting-started/blob/master/docs/SPEC.md#state-message). You can persist State between runs by redirecting messages to a file:\n\n```bash\n$ ~/.venvs/tap-dayforce/bin/tap-dayforce --config=config/dayforce.config.json --catalog=catalog.json >> state.json\n$ tail -1 state.json > state.json.tmp\n$ mv state.json.tmp state.json\n```\n\n## Sync to Stitch\n\nYou can also send the output of the tap to [Stitch Data](https://www.stitchdata.com/) for loading into the data warehouse. To do this, first create a JSON-formatted configuration for Stitch. This configuration file has two required fields:\n1. `client_id`: The ID associated with the Stitch Data account you'll be sending data to.\n2. `token` The token associated with the specific [Import API integration](https://www.stitchdata.com/docs/integrations/import-api/) within the Stitch Data account.\n\nAn example configuration file will look as follows:\n\n```json\n{\n  \"client_id\": 1234,\n  \"token\": \"foobarfoobar\"\n}\n```\n\nOnce the configuration file is created, simply pipe the output of the tap to the Stitch Data target and supply the target with the newly created configuration file:\n\n```bash\n$ ~/.venvs/tap-dayforce/bin/tap-dayforce --config=config/dayforce.config.json --catalog=catalog.json --state=state.json | ~/.venvs/target-stitch/bin/target-stitch --config=config/stitch.config.json >> state.json\n$ tail -1 state.json > state.json.tmp\n$ mv state.json.tmp state.json\n```\n\n## Contributing\n\nThe first step to contributing is getting a copy of the source code. First, [fork `tap-dayforce` on GitHub](https://github.com/goodeggs/tap-dayforce/fork). Then, `cd` into the directory where you want your copy of the source code to live and clone the source code:\n\n```bash\n$ git clone git@github.com:YourGitHubName/tap-dayforce.git\n```\n\nNow that you have a copy of the source code on your local machine, you can leverage [Pipenv](https://docs.pipenv.org/en/latest/) and the corresponding `Pipfile` to install of the development dependencies within a virtual environment:\n\n```bash\n$ pipenv install --three --dev\n```\n\nThis command will create an isolated virtual environment for your `tap-dayforce` project and install all the development dependencies defined within the `Pipfile` inside of the environment. You can then enter a shell within the environment:\n\n```bash\n$ pipenv shell\n```\n\nOr, you can run individual commands within the environment without entering the shell:\n\n```bash\n$ pipenv run <command>\n```\n\nFor example, to format your code using [isort](https://github.com/timothycrosley/isort) and [flake8](http://flake8.pycqa.org/en/latest/index.html) before commiting changes, run the following commands:\n\n```bash\n$ pipenv run make isort\n$ pipenv run make flake8\n```\n\nYou can also run the entire testing suite before committing using [tox](https://tox.readthedocs.io/en/latest/):\n\n```bash\n$ pipenv run tox\n```\n\nFinally, you can run your local version of the tap within the virtual environment using a command like the following:\n\n```bash\n$ pipenv run tap-dayforce --config=config/dayforce.config.json --catalog=catalog.json\n```\n\nOnce you've confirmed that your changes work and the testing suite passes, feel free to put out a PR!\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/goodeggs/tap-dayforce",
        "keywords": "singer tap python dayforce",
        "license": "GPLv3",
        "maintainer": "",
        "maintainer_email": "",
        "name": "tap-dayforce",
        "package_url": "https://pypi.org/project/tap-dayforce/",
        "platform": "",
        "project_url": "https://pypi.org/project/tap-dayforce/",
        "project_urls": {
            "Homepage": "https://github.com/goodeggs/tap-dayforce"
        },
        "release_url": "https://pypi.org/project/tap-dayforce/0.1.0rc2/",
        "requires_dist": [
            "requests (==2.22.0)",
            "singer-python (==5.7.0)"
        ],
        "requires_python": ">=3.6",
        "summary": "Singer.io tap for extracting data from Dayforce REST API v1",
        "version": "0.1.0rc2"
    },
    "last_serial": 5756001,
    "releases": {
        "0.1.0rc1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a741ba1fef3c4ae657c944eb40a87ab8",
                    "sha256": "0fd35f10d9259a4c41f92a4484cc03d016398b725ee5b9c597896633ba3a9fdf"
                },
                "downloads": -1,
                "filename": "tap_dayforce-0.1.0rc1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "a741ba1fef3c4ae657c944eb40a87ab8",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=3.6",
                "size": 23443,
                "upload_time": "2019-08-26T20:03:30",
                "url": "https://files.pythonhosted.org/packages/7b/34/bd5fc58747bbef41368826e6cb84ebbeaca16c69f2508e75ed42f97f908f/tap_dayforce-0.1.0rc1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "60be95b32f01d9c24182f3bee73bd67f",
                    "sha256": "711a98f7bf0effc27126c3f75efcb2a77ffcd332da374279282ad4605d22199c"
                },
                "downloads": -1,
                "filename": "tap_dayforce-0.1.0rc1.tar.gz",
                "has_sig": false,
                "md5_digest": "60be95b32f01d9c24182f3bee73bd67f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 13188,
                "upload_time": "2019-08-26T20:03:32",
                "url": "https://files.pythonhosted.org/packages/dd/78/cb9e1753e4db441e6fd9d5b7a7fc83ace3312e1196d5a4a2994e4d59efd5/tap_dayforce-0.1.0rc1.tar.gz"
            }
        ],
        "0.1.0rc2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1fa6a256df610a25dc87631a7588e181",
                    "sha256": "6d6dfcf992e4025a3c5b832e38f92e8e66a42e9e5830240cc54e6772aa544272"
                },
                "downloads": -1,
                "filename": "tap_dayforce-0.1.0rc2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "1fa6a256df610a25dc87631a7588e181",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=3.6",
                "size": 26210,
                "upload_time": "2019-08-29T18:09:49",
                "url": "https://files.pythonhosted.org/packages/9e/73/3678485e9d5b4770238904acd675b4f478b03b48480d105b750afc5df3ea/tap_dayforce-0.1.0rc2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "5c20851e59f0c83bcd5c6f973c45c73f",
                    "sha256": "d62050c780c012609b9d398569e8c5b94d5c9a2e85dab885eacf676631d24d54"
                },
                "downloads": -1,
                "filename": "tap_dayforce-0.1.0rc2.tar.gz",
                "has_sig": false,
                "md5_digest": "5c20851e59f0c83bcd5c6f973c45c73f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 14403,
                "upload_time": "2019-08-29T18:09:50",
                "url": "https://files.pythonhosted.org/packages/90/e1/033047caf82bccbe52b2e7fed65d34fd8cd8e167eef8d439320ee6d015cf/tap_dayforce-0.1.0rc2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "1fa6a256df610a25dc87631a7588e181",
                "sha256": "6d6dfcf992e4025a3c5b832e38f92e8e66a42e9e5830240cc54e6772aa544272"
            },
            "downloads": -1,
            "filename": "tap_dayforce-0.1.0rc2-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1fa6a256df610a25dc87631a7588e181",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.6",
            "size": 26210,
            "upload_time": "2019-08-29T18:09:49",
            "url": "https://files.pythonhosted.org/packages/9e/73/3678485e9d5b4770238904acd675b4f478b03b48480d105b750afc5df3ea/tap_dayforce-0.1.0rc2-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "5c20851e59f0c83bcd5c6f973c45c73f",
                "sha256": "d62050c780c012609b9d398569e8c5b94d5c9a2e85dab885eacf676631d24d54"
            },
            "downloads": -1,
            "filename": "tap_dayforce-0.1.0rc2.tar.gz",
            "has_sig": false,
            "md5_digest": "5c20851e59f0c83bcd5c6f973c45c73f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 14403,
            "upload_time": "2019-08-29T18:09:50",
            "url": "https://files.pythonhosted.org/packages/90/e1/033047caf82bccbe52b2e7fed65d34fd8cd8e167eef8d439320ee6d015cf/tap_dayforce-0.1.0rc2.tar.gz"
        }
    ]
}