Welcome to osf_api_v2_client’s documentation!¶

Features¶

• Simplifies access of JSON dictionary (dict) data:

  • Instead of user[u'attributes'][u'fullname'], user.attributes.fullname can be used.

  • However, you are not locked into the simplified “dot” access. Both regular dict access and “dot” access will work, and they can be switched up:

    user[u'attributes'].fullname
    user.attributes[u'fullname']
    

  • This works recursively for dicts within dicts (as seen above, given

    user = {u'attributes': {u'fullname': u'John Cleese'}}),

    and for dicts inside a list of dicts (see below).

  • Given:

    dict_with_list = {
        u'mylist': [
            {u'fullname': u'John Cleese'},
            {u'fullname': u'Terry Jones'},
            {u'fullname': u'Eric Idle'}
        ]
    }
    

  • Calls such as the following can be used:

    dict_with_list.mylist[0].fullname
    dict_with_list[u'mylist'][2][u'fullname']
    

• Simplifies access of multiple items:

  • Though items are returned from the API with only a certain number of items per page (often ten), this library takes care of pagination in the background, providing a generator to return all desired items one at a time within a loop.

  • The following example prints the gravatar urls of the first 30 users in the OSF:

    from osf_api_v2_client.session import Session
    
    session = Session()
    for user in session.get_user_generator(num_requested=30):
        print(user.attributes.gravatar_url)
    

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up osf_api_v2_client for local development.

1. Fork the osf_api_v2_client repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/osf_api_v2_client.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv osf_api_v2_client
   $ cd osf_api_v2_client/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 osf_api_v2_client tests
   $ python setup.py test
   

   To get flake8, just pip install it into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes"
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.7, 3.3, and 3.4. Check https://travis-ci.org/jamiehand/osf_api_v2_client/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

Use the command line to run a subset of the tests. You can run tests from modules, classes, or even individual test methods. For example:

$ python -m unittest test_nodes test_session
$ python -m unittest test_nodes.TestGetNodes
$ python -m unittest test_nodes.TestGetNodes.test_get_public_node_auth_non_contrib

Development Leads¶

• jamiehand
• reinaH

Contributors¶

None yet. Why not be the first? See: CONTRIBUTING.rst