Skip to content

Commit

Permalink
add tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
PedramNavid committed Aug 13, 2024
1 parent aa7cac7 commit 9b03ed7
Show file tree
Hide file tree
Showing 4 changed files with 319 additions and 216 deletions.
5 changes: 5 additions & 0 deletions docs/docs-next/docs/concepts/assets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Assets
---

# Assets
84 changes: 84 additions & 0 deletions docs/docs-next/docs/tutorial/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
title: "Installing Dagster"
description: "Learn how to install Dagster"
---

# Installing Dagster Guide

This guide will walk you through the steps to install Dagster, a data orchestrator for machine learning, analytics, and ETL. Follow the instructions below to get started with Dagster on your local machine.


<details>
<summary>Prerequisites</summary>

Before you begin, ensure you have the following prerequisites installed on your system:

- Python 3.7 or higher, Python 3.11 is recommended
- pip (Python package installer)

</details>

## Setup a Virtual Environment

After installing Python, it's a good idea to setup a virtual environment to isolate your Dagster project from the rest of your system.

There are many ways to setup a virtual environment. One method that requires no
additional dependencies is to use `venv`.

```bash
python -m venv .venv
source .venv/bin/activate
```

`pyenv` and `pyenv-virtualenv` are more powerful tools that can help you manage multiple versions of Python on a single machine. You can learn more about them [here](https://github.com/pyenv/pyenv).

## Install Dagster

To install Dagster in your virtual environment, open your terminal and run the following command:

```bash
pip install dagster dagster-webserver
```

This command will install the core Dagster library and the webserver, which is used to serve the Dagster UI.


## Verify Installation

To verify that Dagster is installed correctly, you can run the following command:

```bash
dagster --version
```

You should see the version numbers of Dagster printed in the terminal.

```bash
> dagster --version
dagster, version 1.7.6
```

If you see `dagster, version 1!0+dev`, then you have the development version of Dagster
installed. You can choose to install the latest stable version by providing a version
to the `pip install` command.

For example, to install version 1.7.6, you can run:

```bash
pip install 'dagster==1.7.6'
```

## Conclusion

Congratulations! You have successfully installed Dagster

## Troubleshooting

If you encounter any issues during the installation process, please refer to the [Dagster GitHub repository](https://github.com/dagster-io/dagster) for troubleshooting or reach out to the Dagster community for further assistance.

## Next Steps

- [Quickstart Tutorial](/tutorial/quick-start)
- [ETL Tutorial](/tutorial/tutorial-etl)
- [Create a new Dagster project](/tutorial/create-new-project)
- [Creating Data Assets](/guides/data-assets/creating-data-assets)
14 changes: 7 additions & 7 deletions docs/docs-next/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@
"lint:fix": "prettier . --write && npm run lint:eslint --fix"
},
"dependencies": {
"@docusaurus/core": "3.5.1",
"@docusaurus/plugin-ideal-image": "^3.5.1",
"@docusaurus/preset-classic": "3.5.1",
"@docusaurus/theme-mermaid": "^3.5.1",
"@docusaurus/core": "3.5.2",
"@docusaurus/plugin-ideal-image": "^3.5.2",
"@docusaurus/preset-classic": "3.5.2",
"@docusaurus/theme-mermaid": "^3.5.2",
"@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0",
"docusaurus-plugin-image-zoom": "^2.0.0",
Expand All @@ -33,9 +33,9 @@
"react-dom": "^18.0.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.5.1",
"@docusaurus/tsconfig": "3.5.1",
"@docusaurus/types": "3.5.1",
"@docusaurus/module-type-aliases": "3.5.2",
"@docusaurus/tsconfig": "3.5.2",
"@docusaurus/types": "3.5.2",
"@eslint/js": "^9.9.0",
"@typescript-eslint/parser": "^8.0.1",
"eslint": "^9.9.0",
Expand Down
Loading

0 comments on commit 9b03ed7

Please sign in to comment.