Skip to content

Commit 95cc4bb

Browse files
committed
cleanup example project
1 parent 16d3603 commit 95cc4bb

File tree

5 files changed

+4
-62
lines changed

5 files changed

+4
-62
lines changed

examples/docs_beta_snippets/docs_beta_snippets/guides/components/existing-project/1-tree.txt

+2-4
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ tree
99
├── my_existing_project_tests
1010
│   ├── __init__.py
1111
│   └── test_assets.py
12-
├── pyproject.toml
13-
├── setup.cfg
14-
└── setup.py
12+
└── pyproject.toml
1513

16-
3 directories, 9 files
14+
3 directories, 7 files
Original file line numberDiff line numberDiff line change
@@ -1,47 +1 @@
1-
# my_existing_project
2-
3-
This is a [Dagster](https://dagster.io/) project scaffolded with [`dagster project scaffold`](https://docs.dagster.io/guides/build/projects/creating-a-new-project).
4-
5-
## Getting started
6-
7-
First, install your Dagster code location as a Python package. By using the --editable flag, pip will install your Python package in ["editable mode"](https://pip.pypa.io/en/latest/topics/local-project-installs/#editable-installs) so that as you develop, local code changes will automatically apply.
8-
9-
```bash
10-
pip install -e ".[dev]"
11-
```
12-
13-
Then, start the Dagster UI web server:
14-
15-
```bash
16-
dagster dev
17-
```
18-
19-
Open http://localhost:3000 with your browser to see the project.
20-
21-
You can start writing assets in `my_existing_project/assets.py`. The assets are automatically loaded into the Dagster code location as you define them.
22-
23-
## Development
24-
25-
### Adding new Python dependencies
26-
27-
You can specify new Python dependencies in `setup.py`.
28-
29-
### Unit testing
30-
31-
Tests are in the `my_existing_project_tests` directory and you can run tests using `pytest`:
32-
33-
```bash
34-
pytest my_existing_project_tests
35-
```
36-
37-
### Schedules and sensors
38-
39-
If you want to enable Dagster [Schedules](https://docs.dagster.io/guides/automate/schedules/) or [Sensors](https://docs.dagster.io/guides/automate/sensors/) for your jobs, the [Dagster Daemon](https://docs.dagster.io/guides/deploy/execution/dagster-daemon) process must be running. This is done automatically when you run `dagster dev`.
40-
41-
Once your Dagster Daemon is running, you can start turning on schedules and sensors for your jobs.
42-
43-
## Deploy on Dagster Cloud
44-
45-
The easiest way to deploy your Dagster project is to use Dagster Cloud.
46-
47-
Check out the [Dagster Cloud Documentation](https://docs.dagster.cloud) to learn more.
1+
Sample existing project for testing docs for the "Making an existing code location components-compatible" guide.

examples/docs_beta_snippets/docs_beta_snippets_tests/snippet_checks/guides/components/my-existing-project/setup.cfg

-2
This file was deleted.

examples/docs_beta_snippets/docs_beta_snippets_tests/snippet_checks/guides/components/my-existing-project/setup.py

-8
This file was deleted.

examples/docs_beta_snippets/docs_beta_snippets_tests/snippet_checks/utils.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ def _run_command(
6565
print(f"Ran command {cmd}") # noqa: T201
6666
print("Got output:") # noqa: T201
6767
print(e.output.decode("utf-8").strip()) # noqa: T201
68-
raise e
68+
raise
6969

7070
pwd = PWD_REGEX.search(actual_output).group(1)
7171
actual_output = PWD_REGEX.sub("", actual_output)

0 commit comments

Comments
 (0)