File tree Expand file tree Collapse file tree 1 file changed +24
-0
lines changed
synthtool/gcp/templates/python_library Expand file tree Collapse file tree 1 file changed +24
-0
lines changed Original file line number Diff line number Diff line change @@ -187,6 +187,30 @@ Build the docs via:
187187
188188 $ nox -s docs
189189
190+ *************************
191+ Samples and code snippets
192+ *************************
193+
194+ Code samples and snippets live in the `samples/ ` catalogue. Feel free to
195+ provide more examples, but make sure to write tests for those examples.
196+ Each folder containing example code requires its own `noxfile.py ` script
197+ which automates testing. If you decide to create a new folder, you can
198+ base it on the `samples/snippets ` folder (providing `noxfile.py ` and
199+ the requirements files).
200+
201+ The tests will run against a real Google Cloud Project, so you should
202+ configure them just like the System Tests.
203+
204+ - To run sample tests, you can execute::
205+
206+ # Run all tests in a folder
207+ $ cd samples/snippets
208+ $ nox -s py-3.8
209+
210+ # Run a single sample test
211+ $ cd samples/snippets
212+ $ nox -s py-3.8 -- -k <name of test>
213+
190214********************************************
191215Note About ``README `` as it pertains to PyPI
192216********************************************
You can’t perform that action at this time.
0 commit comments