Metadata-Version: 1.1
Name: PyBambooHR
Version: 0.3.1
Summary: A Python wrapper for the Bamboo HR API
Home-page: http://github.com/smeggingsmegger/PyBambooHR
Author: Scott Blevins
Author-email: sblevins@gmail.com
License: MIT
Description: <h1>PyBambooHR 0.3.1</h1>
        <p><a href="https://travis-ci.org/smeggingsmegger/PyBambooHR"><img alt="Build Status" src="https://secure.travis-ci.org/smeggingsmegger/PyBambooHR.png" /></a></p>
        <p>This is an unofficial Python API for Bamboo HR. So far it is focusing on managing employee information but the plans are to have 100% API coverage eventually.</p>
        <p>The library makes use of the <a href="http://docs.python-requests.org/en/latest/">requests</a> library for Python and <a href="https://github.com/gabrielfalcao/HTTPretty">HTTPretty</a> for testing. A huge thank you to both of those excellent projects.</p>
        <p>Using this library is very simple:</p>
        <p>```python
        from PyBambooHR import PyBambooHR</p>
        <p>bamboo = PyBambooHR(subdomain='yoursub', api_key='yourapikeyhere')</p>
        <p>employees = bamboo.get_employee_directory()
        ```</p>
        <p>(Note that you have to enable sharing employee directory to use that method.)</p>
        <p>This will give you a list of employees with properties on each including their ID.</p>
        <p>```python
        from PyBambooHR import PyBambooHR</p>
        <p>bamboo = PyBambooHR(subdomain='yoursub', api_key='yourapikeyhere')</p>
        <h1>Jim's employee ID is 123 and we are not specifying fields so this will get all of them.</h1>
        <p>jim = bamboo.get_employee(123)</p>
        <h1>Pam's employee ID is 222 and we are specifying fields so this will get only the ones we request.</h1>
        <p>pam = bamboo.get_employee(222, ['city', 'workPhone', 'workEmail'])</p>
        <p>```</p>
        <p>Adding an employee</p>
        <p>```python
        from PyBambooHR import PyBambooHR</p>
        <p>bamboo = PyBambooHR(subdomain='yoursub', api_key='yourapikeyhere')</p>
        <h1>The firstName and lastName keys are required...</h1>
        <p>employee = {'firstName': 'Test', 'lastName': 'Person'}</p>
        <p>result = bamboo.add_employee(employee)</p>
        <p>The result dict will contain id and location. "id" is the numerical BambooHR employee ID. Location is a link to that employee.</p>
        <p>```</p>
        <p>Updating an employee</p>
        <p>```python
        from PyBambooHR import PyBambooHR</p>
        <p>bamboo = PyBambooHR(subdomain='yoursub', api_key='yourapikeyhere')</p>
        <h1>His name was test person...</h1>
        <p>employee = {'firstName': 'Another', 'lastName': 'Namenow'}</p>
        <h1>Use the ID and then the dict with the new information</h1>
        <p>result = bamboo.update_employee(333, employee)</p>
        <p>result will be True or False depending on if it succeeded.</p>
        <p>```</p>
        <p>Requesting a Report</p>
        <p>```python
        from PyBambooHR import PyBambooHR</p>
        <p>bamboo = PyBambooHR(subdomain='yoursub', api_key='yourapikeyhere')</p>
        <h1>Use the ID to request json information</h1>
        <p>result = bamboo.request_company_report(1, format='json', filter_duplicates=True)</p>
        <h1>Now do stuff with your results (Will vary by report.)</h1>
        <p>for employee in result['employees']:
            print(employee)</p>
        <h1>Use the ID and save a pdf:</h1>
        <p>result = bamboo.request_company_report(1, format='pdf', output_file='/tmp/report.pdf', filter_duplicates=True)</p>
        <p>```</p>
        <h1>CHANGES</h1>
        <p>Version 0.3.1 - 24 February 2014</p>
        <ul>
        <li>Raise errors on non-200 statuses</li>
        </ul>
        <p>Version 0.3.0 - 23 February 2014</p>
        <ul>
        <li>Company Reports</li>
        <li>Custom Reports</li>
        </ul>
        <p>Version 0.2.0 - 05 October 2013</p>
        <ul>
        <li>Underscore key support</li>
        <li>Better test coverage</li>
        </ul>
        <p>Version 0.1.0 - 02 October 2013</p>
        <ul>
        <li>Pre-Alpha version</li>
        <li>Uses Bamboo HR API to get employee info.</li>
        </ul>
Keywords: Bamboo,HR,BambooHR,API
Platform: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
