# 🌀 blue-plugin
🌀 `blue-plugin` is a git template for an 🪄 [`awesome-bash-cli`](https://github.com/kamangir/awesome-bash-cli) (`abcli`) plugin, to build [things like these](https://github.com/kamangir?tab=repositories), that out-of-the-box support,
- a [github repo](https://github.com/) with [actions](https://github.com/features/actions).
- [pylint](https://pypi.org/project/pylint/).
- [pytest](https://docs.pytest.org/).
- a pip-installable python + bash package published to [pypi](https://pypi.org/).
- a bash [command interface](https://raw.githubusercontent.com/kamangir/blue-plugin/main/blue_plugin/.abcli/blue_plugin.sh).
- [bash testing](https://raw.githubusercontent.com/kamangir/blue-plugin/main/.github/workflows/bashtest.yml).
- secret management through [ssm](https://docs.aws.amazon.com/secretsmanager/).
- in-repo [compiled](https://raw.githubusercontent.com/kamangir/blue-plugin/main/blue_plugin/README.py) READMEs based on [templates](https://raw.githubusercontent.com/kamangir/blue-plugin/main/template.md).
- [object management](https://github.com/kamangir/blue-objects) on [Amazon S3](https://aws.amazon.com/s3/) with metadata tracking by [MLflow](https://mlflow.org/).
- [workflow management](https://github.com/kamangir/notebooks-and-scripts/tree/main/blueflow/workflow) on [AWS Batch](https://aws.amazon.com/batch/).
- [docker](https://github.com/kamangir/notebooks-and-scripts/blob/main/blueflow/.abcli/docker.sh) and [SageMaker](https://github.com/kamangir/notebooks-and-scripts/blob/main/blueflow/.abcli/sagemaker.sh) enabled.
## installation
```bash
pip install blue-plugin
```
## creating a blue-plugin
1️⃣ create a new repository from [this template](https://github.com/kamangir/blue-plugin),
2️⃣ complete `<repo-name>` and `<plugin-name>` and run,
```bash
@git clone <repo-name> cd
@plugins transform <repo-name>
@init
<plugin-name> help
```
## features
| | | |
| --- | --- | --- |
| 🌀[`feature 1`](#) [](#) description of feature 1 ... | 🌀[`feature 2`](#) [](#) description of feature 2 ... | 🌀[`feature 3`](#) [](#) description of feature 3 ... |
---
[](https://github.com/kamangir/blue-plugin/actions/workflows/pylint.yml) [](https://github.com/kamangir/blue-plugin/actions/workflows/pytest.yml) [](https://github.com/kamangir/blue-plugin/actions/workflows/bashtest.yml) [](https://pypi.org/project/blue-plugin/) [](https://pypistats.org/packages/blue-plugin)
built by 🌀 [`blue_options-4.161.1`](https://github.com/kamangir/awesome-bash-cli), based on 🌀 [`blue_plugin-3.181.1`](https://github.com/kamangir/blue-plugin).
Raw data
{
"_id": null,
"home_page": "https://github.com/kamangir/blue-plugin",
"name": "blue-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Arash Abadpour (Kamangir)",
"author_email": "arash@kamangir.net",
"download_url": "https://files.pythonhosted.org/packages/cd/db/ae654e47ba202d3bef14d86f354d022ff3ce26eb49f718b3c9012e3fa2e2/blue_plugin-3.181.1.tar.gz",
"platform": null,
"description": "# \ud83c\udf00 blue-plugin\n\n\ud83c\udf00 `blue-plugin` is a git template for an \ud83e\ude84 [`awesome-bash-cli`](https://github.com/kamangir/awesome-bash-cli) (`abcli`) plugin, to build [things like these](https://github.com/kamangir?tab=repositories), that out-of-the-box support,\n\n- a [github repo](https://github.com/) with [actions](https://github.com/features/actions).\n- [pylint](https://pypi.org/project/pylint/).\n- [pytest](https://docs.pytest.org/).\n- a pip-installable python + bash package published to [pypi](https://pypi.org/).\n- a bash [command interface](https://raw.githubusercontent.com/kamangir/blue-plugin/main/blue_plugin/.abcli/blue_plugin.sh).\n- [bash testing](https://raw.githubusercontent.com/kamangir/blue-plugin/main/.github/workflows/bashtest.yml).\n- secret management through [ssm](https://docs.aws.amazon.com/secretsmanager/).\n- in-repo [compiled](https://raw.githubusercontent.com/kamangir/blue-plugin/main/blue_plugin/README.py) READMEs based on [templates](https://raw.githubusercontent.com/kamangir/blue-plugin/main/template.md).\n- [object management](https://github.com/kamangir/blue-objects) on [Amazon S3](https://aws.amazon.com/s3/) with metadata tracking by [MLflow](https://mlflow.org/).\n- [workflow management](https://github.com/kamangir/notebooks-and-scripts/tree/main/blueflow/workflow) on [AWS Batch](https://aws.amazon.com/batch/).\n- [docker](https://github.com/kamangir/notebooks-and-scripts/blob/main/blueflow/.abcli/docker.sh) and [SageMaker](https://github.com/kamangir/notebooks-and-scripts/blob/main/blueflow/.abcli/sagemaker.sh) enabled.\n\n## installation\n\n```bash\npip install blue-plugin\n```\n\n## creating a blue-plugin\n\n1\ufe0f\u20e3 create a new repository from [this template](https://github.com/kamangir/blue-plugin),\n\n2\ufe0f\u20e3 complete `<repo-name>` and `<plugin-name>` and run,\n\n```bash\n@git clone <repo-name> cd\n\n@plugins transform <repo-name>\n\n@init\n<plugin-name> help\n```\n\n## features\n\n| | | |\n| --- | --- | --- |\n| \ud83c\udf00[`feature 1`](#) [](#) description of feature 1 ... | \ud83c\udf00[`feature 2`](#) [](#) description of feature 2 ... | \ud83c\udf00[`feature 3`](#) [](#) description of feature 3 ... |\n\n---\n\n\n[](https://github.com/kamangir/blue-plugin/actions/workflows/pylint.yml) [](https://github.com/kamangir/blue-plugin/actions/workflows/pytest.yml) [](https://github.com/kamangir/blue-plugin/actions/workflows/bashtest.yml) [](https://pypi.org/project/blue-plugin/) [](https://pypistats.org/packages/blue-plugin)\n\nbuilt by \ud83c\udf00 [`blue_options-4.161.1`](https://github.com/kamangir/awesome-bash-cli), based on \ud83c\udf00 [`blue_plugin-3.181.1`](https://github.com/kamangir/blue-plugin).\n",
"bugtrack_url": null,
"license": "Public Domain",
"summary": "\ud83c\udf00 a git template for an awesome-bash-cli plugin.",
"version": "3.181.1",
"project_urls": {
"Homepage": "https://github.com/kamangir/blue-plugin"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4653d1eba24eeddd2fe74bb2f2905d4b1baa37eab8267661225bff3d702e8bf8",
"md5": "4013390d89ecfde49a0bc256d1dbdbad",
"sha256": "4fb5e380e2fa941687f3a0a40113827e2ea2c3ca5ced3d60ef479d34b648c1bc"
},
"downloads": -1,
"filename": "blue_plugin-3.181.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4013390d89ecfde49a0bc256d1dbdbad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 16235,
"upload_time": "2024-11-23T21:25:02",
"upload_time_iso_8601": "2024-11-23T21:25:02.729479Z",
"url": "https://files.pythonhosted.org/packages/46/53/d1eba24eeddd2fe74bb2f2905d4b1baa37eab8267661225bff3d702e8bf8/blue_plugin-3.181.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cddbae654e47ba202d3bef14d86f354d022ff3ce26eb49f718b3c9012e3fa2e2",
"md5": "3e3a6387c0fd7a2848dbe6c20ccec495",
"sha256": "e512fffe4b761128261e4a4060c11139ad8470a25de00d1ea402689c627ea3c1"
},
"downloads": -1,
"filename": "blue_plugin-3.181.1.tar.gz",
"has_sig": false,
"md5_digest": "3e3a6387c0fd7a2848dbe6c20ccec495",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10977,
"upload_time": "2024-11-23T21:25:04",
"upload_time_iso_8601": "2024-11-23T21:25:04.405304Z",
"url": "https://files.pythonhosted.org/packages/cd/db/ae654e47ba202d3bef14d86f354d022ff3ce26eb49f718b3c9012e3fa2e2/blue_plugin-3.181.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-23 21:25:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kamangir",
"github_project": "blue-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "blue-plugin"
}
JSON
