Skip to content

Commit 2a48e71

Browse files
chore: remove note about editable installs (#88)
`pip install -e .` is supported and is how we install the library for tests. Source-Author: Bu Sun Kim <8822365+busunkim96@users.noreply.github.com> Source-Date: Tue Sep 22 12:06:12 2020 -0600 Source-Repo: googleapis/synthtool Source-Sha: a651c5fb763c69a921aecdd3e1d8dc51dbf20f8d Source-Link: googleapis/synthtool@a651c5f
1 parent d36f03f commit 2a48e71

File tree

2 files changed

+91
-22
lines changed

2 files changed

+91
-22
lines changed

packages/google-cloud-datastore/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
*****************************************

packages/google-cloud-datastore/synth.metadata

Lines changed: 91 additions & 3 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-datastore",
7-
"sha": "5d78275eee690e53cfaff4f43be1c93bd9598c35"
6+
"remote": "https://github.com/googleapis/python-datastore.git",
7+
"sha": "6a6592d2da8fdf7655c972af695ac7be9182cea3"
88
}
99
},
1010
{
@@ -19,7 +19,7 @@
1919
"git": {
2020
"name": "synthtool",
2121
"remote": "https://github.com/googleapis/synthtool.git",
22-
"sha": "80003a3de2d8a75f5b47cb2e77e018f7f0f776cc"
22+
"sha": "a651c5fb763c69a921aecdd3e1d8dc51dbf20f8d"
2323
}
2424
}
2525
],
@@ -42,5 +42,93 @@
4242
"generator": "bazel"
4343
}
4444
}
45+
],
46+
"generatedFiles": [
47+
".coveragerc",
48+
".flake8",
49+
".github/CONTRIBUTING.md",
50+
".github/ISSUE_TEMPLATE/bug_report.md",
51+
".github/ISSUE_TEMPLATE/feature_request.md",
52+
".github/ISSUE_TEMPLATE/support_request.md",
53+
".github/PULL_REQUEST_TEMPLATE.md",
54+
".github/release-please.yml",
55+
".github/snippet-bot.yml",
56+
".gitignore",
57+
".kokoro/build.sh",
58+
".kokoro/continuous/common.cfg",
59+
".kokoro/continuous/continuous.cfg",
60+
".kokoro/docker/docs/Dockerfile",
61+
".kokoro/docker/docs/fetch_gpg_keys.sh",
62+
".kokoro/docs/common.cfg",
63+
".kokoro/docs/docs-presubmit.cfg",
64+
".kokoro/docs/docs.cfg",
65+
".kokoro/populate-secrets.sh",
66+
".kokoro/presubmit/common.cfg",
67+
".kokoro/presubmit/presubmit.cfg",
68+
".kokoro/publish-docs.sh",
69+
".kokoro/release.sh",
70+
".kokoro/release/common.cfg",
71+
".kokoro/release/release.cfg",
72+
".kokoro/samples/lint/common.cfg",
73+
".kokoro/samples/lint/continuous.cfg",
74+
".kokoro/samples/lint/periodic.cfg",
75+
".kokoro/samples/lint/presubmit.cfg",
76+
".kokoro/samples/python3.6/common.cfg",
77+
".kokoro/samples/python3.6/continuous.cfg",
78+
".kokoro/samples/python3.6/periodic.cfg",
79+
".kokoro/samples/python3.6/presubmit.cfg",
80+
".kokoro/samples/python3.7/common.cfg",
81+
".kokoro/samples/python3.7/continuous.cfg",
82+
".kokoro/samples/python3.7/periodic.cfg",
83+
".kokoro/samples/python3.7/presubmit.cfg",
84+
".kokoro/samples/python3.8/common.cfg",
85+
".kokoro/samples/python3.8/continuous.cfg",
86+
".kokoro/samples/python3.8/periodic.cfg",
87+
".kokoro/samples/python3.8/presubmit.cfg",
88+
".kokoro/test-samples.sh",
89+
".kokoro/trampoline.sh",
90+
".kokoro/trampoline_v2.sh",
91+
".trampolinerc",
92+
"CODE_OF_CONDUCT.md",
93+
"CONTRIBUTING.rst",
94+
"LICENSE",
95+
"MANIFEST.in",
96+
"docs/_static/custom.css",
97+
"docs/_templates/layout.html",
98+
"docs/conf.py",
99+
"google/cloud/datastore_admin_v1/proto/__init__.py",
100+
"google/cloud/datastore_admin_v1/proto/datastore_admin.proto",
101+
"google/cloud/datastore_admin_v1/proto/datastore_admin_pb2.py",
102+
"google/cloud/datastore_admin_v1/proto/datastore_admin_pb2_grpc.py",
103+
"google/cloud/datastore_admin_v1/proto/index.proto",
104+
"google/cloud/datastore_admin_v1/proto/index_pb2.py",
105+
"google/cloud/datastore_admin_v1/proto/index_pb2_grpc.py",
106+
"google/cloud/datastore_v1/gapic/__init__.py",
107+
"google/cloud/datastore_v1/gapic/datastore_client.py",
108+
"google/cloud/datastore_v1/gapic/datastore_client_config.py",
109+
"google/cloud/datastore_v1/gapic/enums.py",
110+
"google/cloud/datastore_v1/gapic/transports/__init__.py",
111+
"google/cloud/datastore_v1/gapic/transports/datastore_grpc_transport.py",
112+
"google/cloud/datastore_v1/proto/__init__.py",
113+
"google/cloud/datastore_v1/proto/datastore.proto",
114+
"google/cloud/datastore_v1/proto/datastore_pb2.py",
115+
"google/cloud/datastore_v1/proto/datastore_pb2_grpc.py",
116+
"google/cloud/datastore_v1/proto/entity.proto",
117+
"google/cloud/datastore_v1/proto/entity_pb2.py",
118+
"google/cloud/datastore_v1/proto/entity_pb2_grpc.py",
119+
"google/cloud/datastore_v1/proto/query.proto",
120+
"google/cloud/datastore_v1/proto/query_pb2.py",
121+
"google/cloud/datastore_v1/proto/query_pb2_grpc.py",
122+
"noxfile.py",
123+
"renovate.json",
124+
"scripts/decrypt-secrets.sh",
125+
"scripts/readme-gen/readme_gen.py",
126+
"scripts/readme-gen/templates/README.tmpl.rst",
127+
"scripts/readme-gen/templates/auth.tmpl.rst",
128+
"scripts/readme-gen/templates/auth_api_key.tmpl.rst",
129+
"scripts/readme-gen/templates/install_deps.tmpl.rst",
130+
"scripts/readme-gen/templates/install_portaudio.tmpl.rst",
131+
"setup.cfg",
132+
"testing/.gitignore"
45133
]
46134
}

0 commit comments

Comments
 (0)