Skip to content

Commit 3861f6b

Browse files
yoshi-automationyoshi-automation
authored
chore: remove note about editable installs (#144)
`pip install -e .` is supported and is how we install the library for tests. Source-Author: Bu Sun Kim <[email protected]> Source-Date: Tue Sep 22 12:06:12 2020 -0600 Source-Repo: googleapis/synthtool Source-Sha: a651c5fb763c69a921aecdd3e1d8dc51dbf20f8d Source-Link: googleapis/synthtool@a651c5f
1 parent a54b5f0 commit 3861f6b

File tree

2 files changed

+124
-23
lines changed

2 files changed

+124
-23
lines changed

‎CONTRIBUTING.rst‎

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -80,25 +80,6 @@ We use `nox <https://nox.readthedocs.io/en/latest/>`__ to instrument our tests.
8080

8181
.. nox: https://pypi.org/project/nox/
8282
83-
Note on Editable Installs / Develop Mode
84-
========================================
85-
86-
- As mentioned previously, using ``setuptools`` in `develop mode`_
87-
or a ``pip`` `editable install`_ is not possible with this
88-
library. This is because this library uses `namespace packages`_.
89-
For context see `Issue #2316`_ and the relevant `PyPA issue`_.
90-
91-
Since ``editable`` / ``develop`` mode can't be used, packages
92-
need to be installed directly. Hence your changes to the source
93-
tree don't get incorporated into the **already installed**
94-
package.
95-
96-
.. _namespace packages: https://www.python.org/dev/peps/pep-0420/
97-
.. _Issue #2316: https://github.com/GoogleCloudPlatform/google-cloud-python/issues/2316
98-
.. _PyPA issue: https://github.com/pypa/packaging-problems/issues/12
99-
.. _develop mode: https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode
100-
.. _editable install: https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs
101-
10283
*****************************************
10384
I'm getting weird errors... Can you help?
10485
*****************************************

‎synth.metadata‎

Lines changed: 124 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
{
44
"git": {
55
"name": ".",
6-
"remote": "git@github.com:googleapis/python-bigtable",
7-
"sha": "474b9f3408efa102533da5b9066cba0cd1ff3a9a"
6+
"remote": "https://github.com/googleapis/python-bigtable.git",
7+
"sha": "617f60b40d82460014333ebdd0cc39155ef77bee"
88
}
99
},
1010
{
@@ -19,14 +19,14 @@
1919
"git": {
2020
"name": "synthtool",
2121
"remote": "https://github.com/googleapis/synthtool.git",
22-
"sha": "9d216d21544b5c9f2c85a6380ffcf20b67e1e459"
22+
"sha": "a651c5fb763c69a921aecdd3e1d8dc51dbf20f8d"
2323
}
2424
},
2525
{
2626
"git": {
2727
"name": "synthtool",
2828
"remote": "https://github.com/googleapis/synthtool.git",
29-
"sha": "9d216d21544b5c9f2c85a6380ffcf20b67e1e459"
29+
"sha": "a651c5fb763c69a921aecdd3e1d8dc51dbf20f8d"
3030
}
3131
}
3232
],
@@ -49,5 +49,125 @@
4949
"generator": "bazel"
5050
}
5151
}
52+
],
53+
"generatedFiles": [
54+
".coveragerc",
55+
".flake8",
56+
".github/CONTRIBUTING.md",
57+
".github/ISSUE_TEMPLATE/bug_report.md",
58+
".github/ISSUE_TEMPLATE/feature_request.md",
59+
".github/ISSUE_TEMPLATE/support_request.md",
60+
".github/PULL_REQUEST_TEMPLATE.md",
61+
".github/release-please.yml",
62+
".github/snippet-bot.yml",
63+
".gitignore",
64+
".kokoro/build.sh",
65+
".kokoro/continuous/common.cfg",
66+
".kokoro/continuous/continuous.cfg",
67+
".kokoro/docker/docs/Dockerfile",
68+
".kokoro/docker/docs/fetch_gpg_keys.sh",
69+
".kokoro/docs/common.cfg",
70+
".kokoro/docs/docs-presubmit.cfg",
71+
".kokoro/docs/docs.cfg",
72+
".kokoro/populate-secrets.sh",
73+
".kokoro/presubmit/common.cfg",
74+
".kokoro/presubmit/presubmit.cfg",
75+
".kokoro/publish-docs.sh",
76+
".kokoro/release.sh",
77+
".kokoro/release/common.cfg",
78+
".kokoro/release/release.cfg",
79+
".kokoro/samples/lint/common.cfg",
80+
".kokoro/samples/lint/continuous.cfg",
81+
".kokoro/samples/lint/periodic.cfg",
82+
".kokoro/samples/lint/presubmit.cfg",
83+
".kokoro/samples/python3.6/common.cfg",
84+
".kokoro/samples/python3.6/continuous.cfg",
85+
".kokoro/samples/python3.6/periodic.cfg",
86+
".kokoro/samples/python3.6/presubmit.cfg",
87+
".kokoro/samples/python3.7/common.cfg",
88+
".kokoro/samples/python3.7/continuous.cfg",
89+
".kokoro/samples/python3.7/periodic.cfg",
90+
".kokoro/samples/python3.7/presubmit.cfg",
91+
".kokoro/samples/python3.8/common.cfg",
92+
".kokoro/samples/python3.8/continuous.cfg",
93+
".kokoro/samples/python3.8/periodic.cfg",
94+
".kokoro/samples/python3.8/presubmit.cfg",
95+
".kokoro/test-samples.sh",
96+
".kokoro/trampoline.sh",
97+
".kokoro/trampoline_v2.sh",
98+
".trampolinerc",
99+
"CODE_OF_CONDUCT.md",
100+
"CONTRIBUTING.rst",
101+
"LICENSE",
102+
"MANIFEST.in",
103+
"docs/_static/custom.css",
104+
"docs/_templates/layout.html",
105+
"docs/conf.py",
106+
"docs/multiprocessing.rst",
107+
"google/cloud/bigtable_admin_v2/__init__.py",
108+
"google/cloud/bigtable_admin_v2/gapic/__init__.py",
109+
"google/cloud/bigtable_admin_v2/gapic/bigtable_instance_admin_client.py",
110+
"google/cloud/bigtable_admin_v2/gapic/bigtable_instance_admin_client_config.py",
111+
"google/cloud/bigtable_admin_v2/gapic/bigtable_table_admin_client.py",
112+
"google/cloud/bigtable_admin_v2/gapic/bigtable_table_admin_client_config.py",
113+
"google/cloud/bigtable_admin_v2/gapic/enums.py",
114+
"google/cloud/bigtable_admin_v2/gapic/transports/__init__.py",
115+
"google/cloud/bigtable_admin_v2/gapic/transports/bigtable_instance_admin_grpc_transport.py",
116+
"google/cloud/bigtable_admin_v2/gapic/transports/bigtable_table_admin_grpc_transport.py",
117+
"google/cloud/bigtable_admin_v2/proto/__init__.py",
118+
"google/cloud/bigtable_admin_v2/proto/bigtable_instance_admin.proto",
119+
"google/cloud/bigtable_admin_v2/proto/bigtable_instance_admin_pb2.py",
120+
"google/cloud/bigtable_admin_v2/proto/bigtable_instance_admin_pb2_grpc.py",
121+
"google/cloud/bigtable_admin_v2/proto/bigtable_table_admin.proto",
122+
"google/cloud/bigtable_admin_v2/proto/bigtable_table_admin_pb2.py",
123+
"google/cloud/bigtable_admin_v2/proto/bigtable_table_admin_pb2_grpc.py",
124+
"google/cloud/bigtable_admin_v2/proto/common.proto",
125+
"google/cloud/bigtable_admin_v2/proto/common_pb2.py",
126+
"google/cloud/bigtable_admin_v2/proto/common_pb2_grpc.py",
127+
"google/cloud/bigtable_admin_v2/proto/instance.proto",
128+
"google/cloud/bigtable_admin_v2/proto/instance_pb2.py",
129+
"google/cloud/bigtable_admin_v2/proto/instance_pb2_grpc.py",
130+
"google/cloud/bigtable_admin_v2/proto/table.proto",
131+
"google/cloud/bigtable_admin_v2/proto/table_pb2.py",
132+
"google/cloud/bigtable_admin_v2/proto/table_pb2_grpc.py",
133+
"google/cloud/bigtable_admin_v2/types.py",
134+
"google/cloud/bigtable_v2/__init__.py",
135+
"google/cloud/bigtable_v2/gapic/__init__.py",
136+
"google/cloud/bigtable_v2/gapic/bigtable_client.py",
137+
"google/cloud/bigtable_v2/gapic/bigtable_client_config.py",
138+
"google/cloud/bigtable_v2/gapic/transports/__init__.py",
139+
"google/cloud/bigtable_v2/gapic/transports/bigtable_grpc_transport.py",
140+
"google/cloud/bigtable_v2/proto/__init__.py",
141+
"google/cloud/bigtable_v2/proto/bigtable.proto",
142+
"google/cloud/bigtable_v2/proto/bigtable_pb2.py",
143+
"google/cloud/bigtable_v2/proto/bigtable_pb2_grpc.py",
144+
"google/cloud/bigtable_v2/proto/data.proto",
145+
"google/cloud/bigtable_v2/proto/data_pb2.py",
146+
"google/cloud/bigtable_v2/proto/data_pb2_grpc.py",
147+
"google/cloud/bigtable_v2/types.py",
148+
"renovate.json",
149+
"samples/AUTHORING_GUIDE.md",
150+
"samples/CONTRIBUTING.md",
151+
"samples/README.md",
152+
"samples/hello/README.md",
153+
"samples/hello_happybase/README.md",
154+
"samples/instanceadmin/README.md",
155+
"samples/metricscaler/README.md",
156+
"samples/quickstart/README.md",
157+
"samples/quickstart_happybase/README.md",
158+
"samples/snippets/README.md",
159+
"samples/tableadmin/README.md",
160+
"scripts/decrypt-secrets.sh",
161+
"scripts/readme-gen/readme_gen.py",
162+
"scripts/readme-gen/templates/README.tmpl.rst",
163+
"scripts/readme-gen/templates/auth.tmpl.rst",
164+
"scripts/readme-gen/templates/auth_api_key.tmpl.rst",
165+
"scripts/readme-gen/templates/install_deps.tmpl.rst",
166+
"scripts/readme-gen/templates/install_portaudio.tmpl.rst",
167+
"setup.cfg",
168+
"testing/.gitignore",
169+
"tests/unit/gapic/v2/test_bigtable_client_v2.py",
170+
"tests/unit/gapic/v2/test_bigtable_instance_admin_client_v2.py",
171+
"tests/unit/gapic/v2/test_bigtable_table_admin_client_v2.py"
52172
]
53173
}

0 commit comments

Comments
 (0)