Skip to content

Commit 89c8b1f

Browse files
Client get scan results (canada-ca#1590)
* Add results query * Implement getting and formatting most recent scan results for domain * Implement getting quick status info for a domain * Add tests for new functions * Added note about IPython issue to readme * Make domain list output format more consistent with other outputs * Undo commenting out part of main (whoops)
1 parent aeb3cac commit 89c8b1f

5 files changed

Lines changed: 788 additions & 18 deletions

File tree

clients/python/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The Tracker Python API Client will provide a Python wrapper for key features of Tracker.
44

5-
It makes use of [GQL](https://github.com/graphql-python/gql), a Python GraphQL client, to query the Tracker API.
5+
It makes use of [gql](https://github.com/graphql-python/gql), a Python GraphQL client, to query the Tracker API.
66

77
#### Installing Dependencies
88

@@ -39,4 +39,8 @@ pipenv run pytest
3939

4040
Alternatively, if you are already in a pipenv shell, just run `pytest`.
4141

42-
If tests are failing with ModuleNotFoundError, make sure tracker_client/ is on your PYTHONPATH. The .env file used to store your credentials is a good way to set this.
42+
If tests are failing with ModuleNotFoundError, make sure tracker_client/ is on your PYTHONPATH. The .env file used to store your credentials is a good way to set this.
43+
44+
#### Note about IPython/Jupyter
45+
46+
Because of a limitation in gql, the client is not currently compatible with IPython or Jupyter.

0 commit comments

Comments
 (0)