# Welcome to Fabsetup!
**Set up and maintain configurations, software installations and other
things on a local or remote linux system.**
Source: <https://github.com/theno/fabsetup>
Documentation: <https://fabsetup.readthedocs.io>
Features:
* Fabsetup's **tasks** do the things:
* tasks execute commands commented and comprehensible
* tasks produce output formatted in Markdown or HTML
* run a task local or on a remote host
* **Addons**:
* only install the tasks you need
* create Your own addon with Your task
* The Command **`fabsetup`**, based on [Fabric](https://www.fabfile.org/),
is a pimped [`fab` command](
https://docs.fabfile.org/en/latest/getting-started.html#addendum-the-fab-command-line-tool)
with the same [options and
arguments](https://docs.fabfile.org/en/latest/cli.html). And some more:
* Control markdown formatted output:
* `--hide-code-block`
* `--hide-command-line`
* `--hide-command-output`
* `--hide-docstring`
* `--hide-header`
* `--hide-print`
* `--unnumbered`
* `--pandoc-add-toc`
* Write output to file:
* `--outfile`
* `--pandoc-html-file`
* Control ANSI color codes:
* `--color-off`
* `--color-keep`
* Control execution of commands:
* `--interactive`
* Load fabfiles and invoke tasks:
* `--load-fab`
* `--load-inv`
* Show effective config:
* `--show-config`
* List known Fabsetup addons:
* `--known-addons`
* **API**:
* for Your own Fabsetup addon
* use Fabsetup in Your own [Fabric tasks](
https://docs.fabfile.org/en/2.5/api/tasks.html#fabric.tasks.task)
and [Invoke tasks](
http://docs.pyinvoke.org/en/latest/getting-started.html#defining-and-running-task-functions)
## Installation
Install fabsetup the same way like
[fabric](https://www.fabfile.org/installing.html), best via
[pip](https://pip.pypa.io/):
```sh
pip install fabsetup
```
## Usage
Run task `info`:
```sh
fabsetup info
```
Important options:
```sh
# Show versions
fabsetup --version
# Help
fabsetup -h
# List tasks
fabsetup -l
# Show task help
fabsetup info --help
fabsetup new --help
```
## Tab Completion
Invokes [shell tab completion](
https://docs.pyinvoke.org/en/stable/invoke.html#tab-completion) also works
with fabsetup:
```sh
fabsetup -h | grep -A1 "completion"
```
Apply this simple setup of tab completion in bash:
```sh
echo 'source <(fabsetup --print-completion-script bash)' >> ~/.bashrc
source ~/.bashrc
```
Now You are able to "tab" through the available fabsetup tasks and options:
```sh
fabsetup --h<TAB><TAB> -> --help --hide --hosts
fabsetup --he<TAB> -> fabsetup --help
fabsetup --help i<TAB> -> fabsetup --help info
```
More features:
[Advanced Usage](https://fabsetup.readthedocs.io/en/latest/advanced-usage.html)
## Addons
Fabsetup itself only comes with two tasks, `info` and `new`. The tasks
that "really do things" reside in separate fabsetup addons.
They will be installed the same way like fabsetup and fabric, best via pip.
For example:
```sh
pip install fabsetup-theno-termdown
```
Now You are able to run the task `theno.termdown`. This task sets up
[termdown](https://github.com/trehn/termdown), locally or on a remote
host:
```sh
# local
fabsetup theno.termdown
# remote
fabsetup -H user@host theno.termdown
```
More infos:
[Fabsetup Addons](https://fabsetup.readthedocs.io/en/latest/addons.html)
## Your Addon
Create Your own fabsetup addon doing great things! Start now:
```sh
fabsetup new
```
More infos:
[Create a Fabsetup Addon](https://fabsetup.readthedocs.io/en/latest/create-addon.html)
Raw data
{
"_id": null,
"home_page": "https://github.com/theno/fabsetup",
"name": "fabsetup",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python development utilities library",
"author": "Theodor Nolte",
"author_email": "fabsetup@theno.eu",
"download_url": "https://files.pythonhosted.org/packages/5d/d6/dd1076821ecee6acd9848caabff8cc33cc20dc84291b68596932450c5712/fabsetup-0.14.0.tar.gz",
"platform": null,
"description": "# Welcome to Fabsetup!\n\n**Set up and maintain configurations, software installations and other\nthings on a local or remote linux system.**\n\nSource: <https://github.com/theno/fabsetup>\n\nDocumentation: <https://fabsetup.readthedocs.io>\n\nFeatures:\n\n* Fabsetup's **tasks** do the things:\n\n * tasks execute commands commented and comprehensible\n * tasks produce output formatted in Markdown or HTML\n * run a task local or on a remote host\n\n* **Addons**:\n\n * only install the tasks you need\n * create Your own addon with Your task\n\n* The Command **`fabsetup`**, based on [Fabric](https://www.fabfile.org/),\n is a pimped [`fab` command](\n https://docs.fabfile.org/en/latest/getting-started.html#addendum-the-fab-command-line-tool)\n with the same [options and\n arguments](https://docs.fabfile.org/en/latest/cli.html). And some more:\n\n * Control markdown formatted output:\n\n * `--hide-code-block`\n * `--hide-command-line`\n * `--hide-command-output`\n * `--hide-docstring`\n * `--hide-header`\n * `--hide-print`\n * `--unnumbered`\n * `--pandoc-add-toc`\n\n * Write output to file:\n\n * `--outfile`\n * `--pandoc-html-file`\n\n * Control ANSI color codes:\n\n * `--color-off`\n * `--color-keep`\n\n * Control execution of commands:\n\n * `--interactive`\n\n * Load fabfiles and invoke tasks:\n\n * `--load-fab`\n * `--load-inv`\n\n * Show effective config:\n\n * `--show-config`\n\n * List known Fabsetup addons:\n\n * `--known-addons`\n\n* **API**:\n\n * for Your own Fabsetup addon\n * use Fabsetup in Your own [Fabric tasks](\n https://docs.fabfile.org/en/2.5/api/tasks.html#fabric.tasks.task)\n and [Invoke tasks](\n http://docs.pyinvoke.org/en/latest/getting-started.html#defining-and-running-task-functions)\n\n## Installation\n\nInstall fabsetup the same way like\n[fabric](https://www.fabfile.org/installing.html), best via\n[pip](https://pip.pypa.io/):\n\n```sh\npip install fabsetup\n```\n\n## Usage\n\nRun task `info`:\n\n```sh\nfabsetup info\n```\n\nImportant options:\n\n```sh\n# Show versions\nfabsetup --version\n\n# Help\nfabsetup -h\n\n# List tasks\nfabsetup -l\n\n# Show task help\nfabsetup info --help\nfabsetup new --help\n```\n\n## Tab Completion\n\nInvokes [shell tab completion](\nhttps://docs.pyinvoke.org/en/stable/invoke.html#tab-completion) also works\nwith fabsetup:\n\n```sh\nfabsetup -h | grep -A1 \"completion\"\n```\n\nApply this simple setup of tab completion in bash:\n\n```sh\necho 'source <(fabsetup --print-completion-script bash)' >> ~/.bashrc\nsource ~/.bashrc\n```\n\nNow You are able to \"tab\" through the available fabsetup tasks and options:\n\n```sh\nfabsetup --h<TAB><TAB> -> --help --hide --hosts\nfabsetup --he<TAB> -> fabsetup --help\nfabsetup --help i<TAB> -> fabsetup --help info\n```\n\nMore features:\n[Advanced Usage](https://fabsetup.readthedocs.io/en/latest/advanced-usage.html)\n\n## Addons\n\nFabsetup itself only comes with two tasks, `info` and `new`. The tasks\nthat \"really do things\" reside in separate fabsetup addons.\n\nThey will be installed the same way like fabsetup and fabric, best via pip.\nFor example:\n\n```sh\npip install fabsetup-theno-termdown\n```\n\nNow You are able to run the task `theno.termdown`. This task sets up\n[termdown](https://github.com/trehn/termdown), locally or on a remote\nhost:\n\n```sh\n# local\nfabsetup theno.termdown\n\n# remote\nfabsetup -H user@host theno.termdown\n```\n\nMore infos:\n[Fabsetup Addons](https://fabsetup.readthedocs.io/en/latest/addons.html)\n\n## Your Addon\n\nCreate Your own fabsetup addon doing great things! Start now:\n\n```sh\nfabsetup new\n```\n\nMore infos:\n[Create a Fabsetup Addon](https://fabsetup.readthedocs.io/en/latest/create-addon.html)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Summary: fabric-2 setup scripts and fabric utils library",
"version": "0.14.0",
"split_keywords": [
"python",
"development",
"utilities",
"library"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "32e2d500f394fd0c47476d8e01833eddaf85559008d86b0ff887c06060f3dac7",
"md5": "9737c3acff052879c282654c61f2c85d",
"sha256": "ff2f7c88da212605c734deba2c9eb83512205e104de962e5feeae1937380fe2c"
},
"downloads": -1,
"filename": "fabsetup-0.14.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9737c3acff052879c282654c61f2c85d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 38550,
"upload_time": "2023-01-11T17:03:41",
"upload_time_iso_8601": "2023-01-11T17:03:41.754996Z",
"url": "https://files.pythonhosted.org/packages/32/e2/d500f394fd0c47476d8e01833eddaf85559008d86b0ff887c06060f3dac7/fabsetup-0.14.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5dd6dd1076821ecee6acd9848caabff8cc33cc20dc84291b68596932450c5712",
"md5": "969aec754a29534ce30ea66d57fe091f",
"sha256": "cdae2a7067865f3d66712147007523ac0a9c159a2f690717d56089d03d3e9eac"
},
"downloads": -1,
"filename": "fabsetup-0.14.0.tar.gz",
"has_sig": false,
"md5_digest": "969aec754a29534ce30ea66d57fe091f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34551,
"upload_time": "2023-01-11T17:03:43",
"upload_time_iso_8601": "2023-01-11T17:03:43.859617Z",
"url": "https://files.pythonhosted.org/packages/5d/d6/dd1076821ecee6acd9848caabff8cc33cc20dc84291b68596932450c5712/fabsetup-0.14.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-11 17:03:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "theno",
"github_project": "fabsetup",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "fabsetup"
}
JSON
