Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commite587029

Browse files
feat: add Samples section to CONTRIBUTING.rst (#785)
Source-Link:googleapis/synthtool@52e4e46Post-Processor: gcr.io/repo-automation-bots/owlbot-python:latest@sha256:6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parente403721 commite587029

File tree

4 files changed

+31
-5
lines changed

4 files changed

+31
-5
lines changed

‎.github/.OwlBot.lock.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
docker:
22
image:gcr.io/repo-automation-bots/owlbot-python:latest
3-
digest:sha256:5ff7446edeaede81c3ed58b23a4e76a5403fba1350ce28478045657303b6479d
3+
digest:sha256:6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605

‎CONTRIBUTING.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,30 @@ Build the docs via:
177177

178178
$ nox -s docs
179179

180+
*************************
181+
Samples and code snippets
182+
*************************
183+
184+
Code samples and snippets live in the `samples/` catalogue. Feel free to
185+
provide more examples, but make sure to write tests for those examples.
186+
Each folder containing example code requires its own `noxfile.py` script
187+
which automates testing. If you decide to create a new folder, you can
188+
base it on the `samples/snippets` folder (providing `noxfile.py` and
189+
the requirements files).
190+
191+
The tests will run against a real Google Cloud Project, so you should
192+
configure them just like the System Tests.
193+
194+
- To run sample tests, you can execute::
195+
196+
# Run all tests in a folder
197+
$ cd samples/snippets
198+
$ nox -s py-3.8
199+
200+
# Run a single sample test
201+
$ cd samples/snippets
202+
$ nox -s py-3.8 -- -k <name of test>
203+
180204
********************************************
181205
Note About ``README`` as it pertains to PyPI
182206
********************************************

‎samples/geography/noxfile.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@
2828
# WARNING - WARNING - WARNING - WARNING - WARNING
2929
# WARNING - WARNING - WARNING - WARNING - WARNING
3030

31-
# Copy `noxfile_config.py` to your directory and modify it instead.
31+
BLACK_VERSION="black==19.10b0"
3232

33+
# Copy `noxfile_config.py` to your directory and modify it instead.
3334

3435
# `TEST_CONFIG` dict is a configuration hook that allows users to
3536
# modify the test configurations. The values here should be in sync
@@ -159,7 +160,7 @@ def lint(session: nox.sessions.Session) -> None:
159160

160161
@nox.session
161162
defblacken(session:nox.sessions.Session)->None:
162-
session.install("black")
163+
session.install(BLACK_VERSION)
163164
python_files= [pathforpathinos.listdir(".")ifpath.endswith(".py")]
164165

165166
session.run("black",*python_files)

‎samples/snippets/noxfile.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@
2828
# WARNING - WARNING - WARNING - WARNING - WARNING
2929
# WARNING - WARNING - WARNING - WARNING - WARNING
3030

31-
# Copy `noxfile_config.py` to your directory and modify it instead.
31+
BLACK_VERSION="black==19.10b0"
3232

33+
# Copy `noxfile_config.py` to your directory and modify it instead.
3334

3435
# `TEST_CONFIG` dict is a configuration hook that allows users to
3536
# modify the test configurations. The values here should be in sync
@@ -159,7 +160,7 @@ def lint(session: nox.sessions.Session) -> None:
159160

160161
@nox.session
161162
defblacken(session:nox.sessions.Session)->None:
162-
session.install("black")
163+
session.install(BLACK_VERSION)
163164
python_files= [pathforpathinos.listdir(".")ifpath.endswith(".py")]
164165

165166
session.run("black",*python_files)

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp