Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions packages/google-cloud-bigtable/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ Code samples and snippets live in the `samples/` catalogue. Feel free to
provide more examples, but make sure to write tests for those examples.
Each folder containing example code requires its own `noxfile.py` script
which automates testing. If you decide to create a new folder, you can
base it on the `samples/snippets` folder (providing `noxfile.py` and
base it on the `samples/data_client_async/snippets` folder (providing `noxfile.py` and
the requirements files).

The tests will run against a real Google Cloud Project, so you should
Expand All @@ -194,11 +194,11 @@ configure them just like the System Tests.
- To run sample tests, you can execute::

# Run all tests in a folder
$ cd samples/snippets
$ cd samples/data_client_async/snippets
$ nox -s py-3.14

# Run a single sample test
$ cd samples/snippets
$ cd samples/data_client_async/snippets
$ nox -s py-3.14 -- -k <name of test>

********************************************
Expand Down
1 change: 0 additions & 1 deletion packages/google-cloud-bigtable/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,6 @@
"**/.nox/**/*",
"samples/AUTHORING_GUIDE.md",
"samples/CONTRIBUTING.md",
"samples/snippets/README.rst",
]

# The reST default role (used for this markup: `text`) to use for all
Expand Down
42 changes: 33 additions & 9 deletions packages/google-cloud-bigtable/samples/README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,48 @@
[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
[//]: # "To regenerate it, use `python -m synthtool`."
# Python Code Samples for Cloud Bigtable

## Python Samples for Cloud Bigtable
This directory contains code samples for Cloud Bigtable, which may be used as a reference for using this product.

This directory contains samples for Cloud Bigtable, which may be used as a refererence for how to use this product.
## Prerequisites

1. If this is your first time working with GCP products, you will need to set up [the Cloud SDK][cloud_sdk] or utilize [Google Cloud Shell][gcloud_shell]. This sample may [require authentication][authentication] and you will need to [enable billing][enable_billing].

2. Set your environment variables:
```bash
export GOOGLE_CLOUD_PROJECT="your-project-id"
export BIGTABLE_INSTANCE="your-instance-id"
```

## Running Samples and Tests

1. Install dependencies for the sample module you want to run:
```bash
pip install -r requirements.txt
```

2. Run sample scripts directly:
```bash
python main.py $GOOGLE_CLOUD_PROJECT $BIGTABLE_INSTANCE
```

3. To run sample tests using Nox:
```bash
nox -s py-3.14
```

## Additional Information

You can read the documentation for more details on API usage and use GitHub
to <a href="https://github.com/googleapis/python-bigtable">browse the source</a> and [report issues][issues].
to <a href="https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-bigtable">browse the source</a> and [report issues][issues].

### Contributing
View the [contributing guidelines][contrib_guide], the [Python style guide][py_style] for more information.

View the [contributing guidelines][contrib_guide] and the [Python style guide][py_style] for more information.

[authentication]: https://cloud.google.com/docs/authentication/getting-started
[enable_billing]:https://cloud.google.com/apis/docs/getting-started#enabling_billing
[enable_billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
[client_library_python]: https://googlecloudplatform.github.io/google-cloud-python/
[issues]: https://github.com/GoogleCloudPlatform/google-cloud-python/issues
[issues]: https://github.com/googleapis/google-cloud-python/issues
[contrib_guide]: https://github.com/googleapis/google-cloud-python/blob/main/CONTRIBUTING.rst
[py_style]: http://google.github.io/styleguide/pyguide.html
[cloud_sdk]: https://cloud.google.com/sdk/docs
[gcloud_shell]: https://cloud.google.com/shell/docs
[gcloud_shell]: https://cloud.google.com/shell/docs
52 changes: 0 additions & 52 deletions packages/google-cloud-bigtable/samples/hello/README.md

This file was deleted.

This file was deleted.

52 changes: 0 additions & 52 deletions packages/google-cloud-bigtable/samples/instanceadmin/README.md

This file was deleted.

52 changes: 0 additions & 52 deletions packages/google-cloud-bigtable/samples/metricscaler/README.md

This file was deleted.

Loading
Loading