Notes and FAQ#

The following questions have come up in previous conversations:

  • Why is the SDK camel-cased? True, Python code should be snake-cased. This was a design decision to align all the SDKS. All the functions and fields should look the same, so you can easily switch from one language to another without having to read documentation. This may change in the future as we grow the SDKs.

  • Which user should I use? The guest@navability.io user is open and free for everyone to use. We recommend testing with this user, because it doesn’t require any authentication. Note though, that the data is cleared on a regular basis, and that everyone can see your test data (all Guest users are created equal), so don’t put anything in there that is sensitive.

  • I have sensitive data, how do I create a user? Great question, the NavAbility services completely isolate data per user and you can create a user at any point. At the moment we create users on demand because the services are changing as we develop them, and we want to make sure we can let everyone know as they do. Send us an email at info@navability.io and we’ll create a user for you right away.

  • Why Asyncio? We’re working on integrating these into Example Jupyter Notebooks which only support asynchronous GQL calls in the gql library. This design decision will be standardized in all our SDKs in the next release. Overally it’s been a good call, and we’ll expand on more asynchronous functionality as these SDKs develop.

  • Why IPython? We’re temporarily importing IPython to generate links for our notebooks and this will be removed in the near future.

  • Otherwise for any questions, comments, or feedback please feel free to email us at info@navability.io or write an issue on the repo.