@@ -146,3 +146,36 @@ users = generated.User.list(api_context)
146146
147147##### Example
148148See [ ` UserListExample.py ` ] ( ./examples/user_list_example.py )
149+
150+ ## Running Samples
151+ In order to make the experience of getting into bunq Python SDK smoother, we
152+ have bundled it with example use cases (located under ` /examples ` ).
153+
154+ To run an example, please do the following:
155+ 1 . In your IDE, open the example you are interested in and adjust the constants,
156+ such as ` _API_KEY ` or ` _USER_ID ` , to hold your data.
157+ 2 . In your terminal, go to the root of bunq SDK project:
158+
159+ ``` shell
160+ $ cd /path/to/bunq/sdk/
161+ ```
162+ 3 . In the terminal, run:
163+
164+ ``` shell
165+ $ python3 run.py examples/< something_example.py>
166+ ```
167+ Replace ` <something_example.py> ` with the name of the example you would like
168+ to run. If you wish to run the example with python 2, also replace
169+ ` python3 ` with ` python ` .
170+
171+ In order for examples to run, you would need a valid context file (` bunq.conf ` )
172+ to be present in the bunq SDK project root directory. The file can either copied
173+ from somewhere else (e.g. tests) or created by running the following command
174+ in your bunq SDK project root directory:
175+
176+ ``` shell
177+ $ python3 run.py examples/api_context_save_example.py
178+ ```
179+
180+ Please do not forget to set the ` _API_KEY ` constant in
181+ ` api_context_save_example.py ` to your actual API key before running the sample!
0 commit comments