Skip to content

Commit

Permalink
chore: update readme - rm foresight rip [ci-skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
robcxyz committed Jun 18, 2023
1 parent 45351a6 commit 43cabce
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@
[![python](https://img.shields.io/pypi/pyversions/tackle.svg)](https://pypi.python.org/pypi/tackle)
[![codecov](https://codecov.io/gh/sudoblockio/tackle/branch/main/graphs/badge.svg?branch=main)](https://codecov.io/github/sudoblockio/tackle?branch=main)
[![codeql](https://github.com/sudoblockio/tackle/actions/workflows/codeql.yml/badge.svg)](https://github.com/sudoblockio/tackle/actions/workflows/codeql.yml)
[![Foresight Docs](https://api-public.service.runforesight.com/api/v1/badge/success?repoId=d40e333a-c337-4337-ab95-9c4c34d47f9e)](https://docs.runforesight.com/)
[![Foresight Docs](https://api-public.service.runforesight.com/api/v1/badge/test?repoId=d40e333a-c337-4337-ab95-9c4c34d47f9e)](https://docs.runforesight.com/)
[![Foresight Docs](https://api-public.service.runforesight.com/api/v1/badge/utilization?repoId=d40e333a-c337-4337-ab95-9c4c34d47f9e)](https://docs.runforesight.com/)

[//]: # ([![main-tests](https://github.com/sudoblockio/tackle/actions/workflows/main.yml/badge.svg)](https://github.com/sudoblockio/tackle/actions))

Expand All @@ -19,7 +16,7 @@

[//]: # (* [Slack](https://join.slack.com/t/slack-y748219/shared_invite/zt-1cqreswyd-5qDBE53QlY97mQOI6DhcKw))

Tackle is an experimental general purpose configuration language for building modular code generators and declarative CLIs. Built as a fork of [cookiecutter](https://github.com/cookiecutter/cookiecutter), it can make any config file dynamic or into a CLI with both strong and weakly typed programmable flow control common to a general purpose programming language. Basically you can write a fully functional Turing-complete program out of a config file. It's wild.
Tackle is an experimental general purpose configuration language for building modular code generators and declarative CLIs. Built as a fork of [cookiecutter](https://github.com/cookiecutter/cookiecutter), it can make any config file into a CLI with both strong and weakly typed programmable flow control common to a general purpose programming language. Basically you can write a fully functional Turing-complete program out of a config file. It's wild.

**With tackle, you can build:**
- Modular code generators / repo scaffolding tools that can be updated over time
Expand All @@ -46,6 +43,7 @@ Tackle is an experimental general purpose configuration language for building mo
- [Run other tackle files](https://sudoblockio.github.io/tackle/providers/Tackle/tackle/)
- Modular design allows creating / importing new hooks easy
- Supports both [python](https://sudoblockio.github.io/tackle/python-hooks/) and [declarative](https://sudoblockio.github.io/tackle/declarative-hooks/) hooks which can be imported / called / defined in-line or within jinja templates
- Hooks can be composed of other hooks allowing complex objects to be validated and operated against

### Install

Expand Down Expand Up @@ -149,7 +147,7 @@ Documentation can be embedded into the hooks.
<-:
help: This is the default hook
target:
type: str
type: union[str, int]
default->: input
description: The thing to say hello to
exec<-:
Expand All @@ -158,6 +156,7 @@ Documentation can be embedded into the hooks.
greeting-method<-:
help: A method that greets
# ... Greeting options / logic
extends: greeter
greeter<-:
help: A reusable greeter object
target: str
Expand All @@ -179,7 +178,7 @@ methods:
greeter A reusable greeter object
```

Hooks can be imported [within a tackle provider](https://sudoblockio.github.io/tackle/declarative-cli/#importing-hooks) or [through hooks](https://sudoblockio.github.io/tackle/providers/Tackle/import/), [linked](https://sudoblockio.github.io/tackle/providers/Tackle/tackle/), and/or [combined](https://sudoblockio.github.io/tackle/declarative-hooks/#extending-hooks) creating a web of CLIs.
Hooks can be imported [within a tackle provider](https://sudoblockio.github.io/tackle/declarative-cli/#importing-hooks) or [through hooks](https://sudoblockio.github.io/tackle/providers/Tackle/import/), [linked](https://sudoblockio.github.io/tackle/providers/Tackle/tackle/), and/or combined with [inheritance](https://sudoblockio.github.io/tackle/declarative-hooks/#extending-hooks) or [composition](https://sudoblockio.github.io/tackle/declarative-hooks/#extending-hooks) creating a web of CLIs.

### Use Cases

Expand Down

0 comments on commit 43cabce

Please sign in to comment.