Skip to content

Commit

Permalink
fixes on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
luiztauffer committed Oct 14, 2023
1 parent 1e91525 commit a1fd28e
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 122 deletions.
109 changes: 0 additions & 109 deletions README-pypi.md

This file was deleted.

25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,15 @@
<a href="https://artifacthub.io/packages/helm/domino/domino">
<img src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/domino">
</a>
<a href="https://domino-py.readthedocs.io/en/latest/">
<a href="https://tauffer-consulting.github.io/domino-docs/docs/intro">
<img alt="Read the Docs" src="https://img.shields.io/readthedocs/domino-py?label=Docs&logo=Read%20the%20Docs&logoColor=white">
</a>
<a href="https://github.com/sponsors/Tauffer-Consulting">
<img src="https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86">
</a>
</p>


<br>

![create workflow](https://raw.githubusercontent.com/Tauffer-Consulting/domino/main/docs/source/_static/media/7_create_workflow.gif)
Expand All @@ -29,14 +33,14 @@
<br>

# About
Domino is an open source workflow management platform, with:
**Domino is an open source workflow management platform**, with:

- :desktop_computer: an intuitive [Graphical User Interface](#gui) that facilitates creating, editing and monitoring any type of Workflow, from data processing to machine learning
- :package: a standard way of writing and publishing functional [Pieces](#pieces), which follows good practices for data modeling, documentation and distribution
- :gear: a [REST API](#rest) that controls a running Apache Airflow instance


Creating Workflows in the GUI is as simple as dragging and dropping Pieces to the canvas, and connecting them. The user can also schedule the Workflow to run periodically, at a specific date/time, or trigger it manually. The monitoring page shows the status of each Workflow Piece in real time, including the logs and results of each run.
Creating Workflows in the GUI is as simple as dragging and dropping Pieces to the canvas, and connecting them. The user can schedule the Workflow to run periodically, at a specific date/time, or trigger it manually. The monitoring page shows the status of each Workflow Piece in real time, including the logs and results of each run.

Pieces are functional units that can be reused in multiple Workflows. Pieces can execute anything that can be written in Python, and can be easily distributed and installed directly from Github repositories to be used in Domino Workflows.

Expand All @@ -60,7 +64,7 @@ You can think of Domino as Airflow with superpowers:
The Domino Python package can be installed via pip. We reccommend you install Domino in a separate Python environment.

```bash
pip install domino-py
pip install domino-py[cli]
```

You can then use Domino command line interface to easily run the Domino platform locally (requires [Docker Compose V2](https://docs.docker.com/compose/)). Go to a new, empty directory and run the following command:
Expand All @@ -69,11 +73,10 @@ You can then use Domino command line interface to easily run the Domino platform
domino platform run-compose
```

After all processes started successfully, navigate to `localhost:3000` to access the Domino frontend service.
After all processes started successfully, navigate to `localhost:3000` to access the Domino frontend service. <br>
Obs.: the first time you run the platform, it may take a few minutes to download the Docker images.

Running the Domino platform locally with Docker compose is useful for development and testing purposes. For production environments, we recommend you install Domino in a Kubernetes cluster:
- Running Domino in a [local Kubernetes cluster with Kind](https://domino-py.readthedocs.io/en/latest/pages/platform.html)
- Running Domino in a [remote Kubernetes cluster](https://domino-py.readthedocs.io/en/latest/pages/deployment_cloud.html)
Running the Domino platform locally with Docker compose is useful for development and testing purposes. For production environments, we recommend you install Domino in a Kubernetes cluster. For local testing, check out the instructions for running Domino in a [local Kubernetes cluster with Kind](https://domino-py.readthedocs.io/en/latest/pages/platform.html).

<br>

Expand Down Expand Up @@ -164,9 +167,9 @@ Pieces are the secret sauce of Domino, they are functional units that can be dis

It is very easy to create and share your own Pieces:

1️⃣ write your Python function as a Piece <br>
2️⃣ define the data types, dependencies, metadata and tests <br>
3️⃣ publish in a git repository (public or private)
1. write your Python function as a Piece <br>
2. define the data types, dependencies, metadata and tests <br>
3. publish in a git repository (public or private)

The [Pieces repository template](https://github.com/Tauffer-Consulting/domino_pieces_repository_template) provides the basic structure, example files and automatic actions for a seamless Pieces creation experience.

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ domino = [

[tool.setuptools.dynamic]
version = { attr = "domino.__version__" }
readme = { file = "README-pypi.md" }
readme = { file = 'README.md', content-type = 'text/markdown' }

[project.scripts]
domino = "domino.cli.cli:cli"
Expand Down
2 changes: 1 addition & 1 deletion src/domino/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.5.1
0.5.2
1 change: 1 addition & 0 deletions src/domino/task.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ class Task(object):
The Task object represents a task in a workflow.
It is only instantiated by processes parsing dag files in Airflow.
"""

def __init__(
self,
dag: DAG,
Expand Down

0 comments on commit a1fd28e

Please sign in to comment.