Getting Started#

Installation#

All platforms via pip:

$ pip install -U recnetpy

Quickstart#

Creating an instance of RecNetPy:

import recnetpy

RecNet = recnetpy.Client()

An example that showcases how to fetch an account by username and acquire its bio:

import recnetpy
from asyncio import get_event_loop

async def main():
    RecNet = recnetpy.Client()
    user = await RecNet.accounts.get("ColinXYZ")
    bio = await user.get_bio()
    print(bio)
    await RecNet.close()

loop = get_event_loop()
loop.run_until_complete(main())

Note

For more examples and usage, please refer to the Examples.

Development Setup#

To install a local build run the following command.

$ pip install .

Contributing#

  1. Fork it (<https://github.com/RecNetBot-Development/RecNetPy/fork>)

  2. Create your feature branch (git checkout -b feature/fooBar)

  3. Commit your changes (git commit -am ‘Add some fooBar’)

  4. Push to the branch (git push origin feature/fooBar)

  5. Create a new Pull Request