Skip to content

Commit a4adf1a

Browse files
authored
Merge pull request #77 from NavAbility/minifix/ipython
Adding IPython dependency and updating documentation
2 parents 713be4f + 51f0c4c commit a4adf1a

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,12 @@ If you don't, you'll see `SyntaxError: 'await' outside function`.
2020
# Notes and FAQ
2121

2222
- **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.
23-
- **Which user should I use?** The Guest 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 that is sensitive.
23+
- **Which user should I use?** The `[email protected]` 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 that is sensitive.
2424
- **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 [[email protected]](mailto:[email protected]) and we'll create a user for you right away.
2525
- **Why Asyncio?** We're working on integrating these into [Example Jupyter Notebooks](https://github.com/NavAbility/BinderNotebooks) 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.
26+
- **Why IPython?** We're temporarily importing IPython to generate links for our notebooks and this will be removed in the near future.
2627
- Otherwise for any questions, comments, or feedback please feel free to email us at [[email protected]](mailto:[email protected]) or write an issue on the repo.
28+
2729
# Example
2830

2931
This script will create variables and factors, list the graph, and solve the session for SLAM estimates.

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
install_requires=[
3131
"click==8.0.2",
3232
"gql[all]==3.0.0a6",
33+
"ipython==8.2.0",
3334
"marshmallow==3.14.0",
3435
"numpy>=1.21",
3536
# Dev/test dependencies

0 commit comments

Comments
 (0)