Skip to content

Commit 04763f8

Browse files
Add Input Prompting (#43)
* feat: add prompting for rulesets and input dir * doc: add autocomplete instructions * doc: add or adjust help text on commands and error msgs * doc: various doc updates * fix: typo * fix: get resolved version of path, when prompting * chore: version bump * doc: standardize cli docs * doc: update + alpha-sort translations * doc: update + alpha-sort translations
1 parent 41b5f45 commit 04763f8

File tree

5 files changed

+205
-67
lines changed

5 files changed

+205
-67
lines changed

docs/cli.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,19 @@ You can alter the verbosity of the CLI by setting the `LOG_LEVEL` environment va
1313
```shell
1414
export LOG_LEVEL=DEBUG
1515
```
16+
17+
18+
## Autocomplete
19+
20+
Auto-completion is available for the CLI. To enable it, run the following command or place it in `.bashrc` or `.zshrc`:
21+
22+
### Bash
23+
```shell
24+
eval "$(_ORBITER_COMPLETE=bash_source orbiter)"
25+
```
26+
27+
28+
### ZSH
29+
```shell
30+
eval "$(_ORBITER_COMPLETE=zsh_source orbiter)"
31+
```

docs/index.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -36,32 +36,25 @@ are available for download on the [Releases](https://github.com/astronomer/orbit
3636
Utilize the [`orbiter` CLI](./cli.md) with existing translations to convert workflows
3737
from other systems to an Airflow project.
3838

39-
1. Set up a new folder, and create a `workflow/` folder. Add your workflows files to it
39+
1. **Set up a new `workflow/` folder. Add your workflows files to it**
4040
```shell
4141
.
4242
└── workflow/
4343
├── workflow_a.json
4444
├── workflow_b.json
4545
└── ...
4646
```
47-
2. Determine the specific translation ruleset via:
47+
2. Determine the specific translation ruleset and repository via:
4848
1. the [Origins](./origins.md) documentation
4949
2. the [`orbiter list-rulesets`](./cli.md#list-rulesets) command
5050
3. or [by creating a translation ruleset](#authoring-rulesets-customization), if one does not exist
51-
3. Install the translation ruleset via the [`orbiter install`](./cli.md#install) command (substituting `<REPOSITORY>` with the value in the last step)
52-
```shell
53-
orbiter install --repo=<REPOSITORY>
54-
```
55-
4. Use the [`orbiter translate`](./cli.md#translate) command with the `<RULESET>` determined in the last step
56-
This will produce output to an `output/` folder:
57-
```shell
58-
orbiter translate workflow/ --ruleset <RULESET> output/
59-
```
60-
5. Review the contents of the `output/` folder. If extensions or customizations are required, review
61-
[how to extend a translation ruleset](#extend-or-customize)
62-
6. (optional) Utilize the [`astro` CLI](https://www.astronomer.io/docs/astro/cli/overview)
63-
to run Airflow instance with your migrated workloads
64-
7. (optional) Deploy to [Astro](https://www.astronomer.io/try-astro/) to run your translated workflows in production! 🚀
51+
3. **Install the translation ruleset** via the [`orbiter install`](./cli.md#install) command
52+
4. **Translate workloads** via the [`orbiter translate`](./cli.md#translate) command
53+
5. **Review** the contents of the output folder (default: `output/`).
54+
If extensions or customizations are required, review [how to extend a translation ruleset](#extend-or-customize)
55+
6. (optional) **Initialize** a full Airflow project
56+
containing your migrated workloads with the [`astro` CLI](https://www.astronomer.io/docs/astro/cli/overview)
57+
7. (optional) **Deploy** to [Astro](https://www.astronomer.io/try-astro/) to run your translated workflows in production! 🚀
6558

6659
## Authoring Rulesets & Customization
6760
Orbiter can be extended to fit specific needs, patterns, or to support additional origins.
@@ -95,9 +88,9 @@ To extend or customize an existing ruleset, you can easily modify it with simple
9588
7. Append the new [Rule](./Rules_and_Rulesets/index.md)
9689
to the [`translation_ruleset`](./Rules_and_Rulesets/rulesets.md#orbiter.rules.rulesets.TranslationRuleset)
9790

98-
4. Invoke the `orbiter` CLI, pointing it at your customized ruleset, and writing output to an `output/` folder:
91+
4. Invoke the [`orbiter translate`](./cli.md#translate) command, pointing it at your customized ruleset
9992
```shell
100-
orbiter translate workflow/ output/ --ruleset override.translation_ruleset
93+
orbiter translate --ruleset override.translation_ruleset
10194
```
10295
5. Follow the remaining steps of the [Translate](#translate) instructions
10396

orbiter/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import re
44
from typing import Any, Tuple
55

6-
__version__ = "1.4.3"
6+
__version__ = "1.5.0"
77

88
version = __version__
99

0 commit comments

Comments
 (0)