databricks-cli/libs/template/templates/default-python/template/{{.project_name}}
Lennart Kats (databricks) 167deec8c3
Change recommended production deployment path from /Shared to /Users (#1091)
## Changes

This PR changes the default and `mode: production` recommendation to
target `/Users` for deployment. Previously, we used `/Shared`, but
because of a lack of POSIX-like permissions in WorkspaceFS this meant
that files inside would be readable and writable by other users in the
workspace.

Detailed change:
* `default-python` no longer uses a path that starts with `/Shared`
* `mode: production` no longer requires a path that starts with
`/Shared`
 
## Related PRs

Docs: https://github.com/databricks/docs/pull/14585
Examples: https://github.com/databricks/bundle-examples/pull/17

## Tests

* Manual tests
* Template unit tests (with an extra check to avoid /Shared)
2024-01-02 19:58:24 +00:00
..
.vscode Make the default `databricks bundle init` template more self-explanatory (#796) 2023-09-26 09:12:34 +00:00
fixtures Minor default template tweaks (#758) 2023-09-11 07:36:44 +00:00
resources Improve default template (#1046) 2023-12-11 19:13:14 +00:00
scratch databricks bundle init template v2: optional stubs, DLT support (#700) 2023-09-06 09:52:31 +00:00
src Work around DLT issue with `$PYTHONPATH` not being set correctly (#999) 2023-11-20 19:25:43 +00:00
tests Make the default `databricks bundle init` template more self-explanatory (#796) 2023-09-26 09:12:34 +00:00
.gitignore Improve default template (#1046) 2023-12-11 19:13:14 +00:00
README.md.tmpl Improve default template (#1046) 2023-12-11 19:13:14 +00:00
databricks.yml.tmpl Change recommended production deployment path from /Shared to /Users (#1091) 2024-01-02 19:58:24 +00:00
pytest.ini databricks bundle init template v1 (#686) 2023-09-05 11:58:34 +00:00
requirements-dev.txt.tmpl Improve default template (#1046) 2023-12-11 19:13:14 +00:00
setup.py.tmpl Change default_python template to auto-update version on each wheel build (#1034) 2023-12-01 13:24:55 +00:00

README.md.tmpl

# {{.project_name}}

The '{{.project_name}}' project was generated by using the default-python template.

## Getting started

1. Install the Databricks CLI from https://docs.databricks.com/dev-tools/cli/databricks-cli.html

2. Authenticate to your Databricks workspace:
    ```
    $ databricks configure
    ```

3. To deploy a development copy of this project, type:
    ```
    $ databricks bundle deploy --target dev
    ```
    (Note that "dev" is the default target, so the `--target` parameter
    is optional here.)

    This deploys everything that's defined for this project.
    For example, the default template would deploy a job called
    `[dev yourname] {{.project_name}}_job` to your workspace.
    You can find that job by opening your workpace and clicking on **Workflows**.

4. Similarly, to deploy a production copy, type:
   ```
   $ databricks bundle deploy --target prod
   ```

5. To run a job or pipeline, use the "run" command:
   ```
   $ databricks bundle run
   ```

6. Optionally, install developer tools such as the Databricks extension for Visual Studio Code from
   https://docs.databricks.com/dev-tools/vscode-ext.html.
{{- if (eq .include_python "yes") }} Or read the "getting started" documentation for
   **Databricks Connect** for instructions on running the included Python code from a different IDE.
{{- end}}

7. For documentation on the Databricks asset bundles format used
   for this project, and for CI/CD configuration, see
   https://docs.databricks.com/dev-tools/bundles/index.html.