| Name | cici-tools JSON |
| Version |
0.8.1
JSON |
| download |
| home_page | None |
| Summary | Power tools for CI/CD. |
| upload_time | 2024-12-17 05:32:17 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
ci
pipeline
python
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# cici-tools
<!-- BADGIE TIME -->
[](https://gitlab.com/buildgarden/tools/cici-tools/-/commits/main)
[](https://gitlab.com/buildgarden/tools/cici-tools/-/commits/main)
[](https://gitlab.com/buildgarden/tools/cici-tools/-/releases)
[](https://github.com/pre-commit/pre-commit)
[](https://github.com/prettier/prettier)
<!-- END BADGIE TIME -->
Power tools for CI/CD.
> Do not use this software unless you are an active collaborator on the
> associated research project.
>
> This project is an output of an ongoing, active research project. It is
> published without warranty, is subject to change at any time, and has not been
> certified, tested, assessed, or otherwise assured of safety by any person or
> organization. Use at your own risk.
## Usage
### `bundle`
Flatten `extends` keywords to make zero-dependency GitLab CI/CD files.
```bash
cici bundle
```
```console
$ cici bundle
⚡ python-autoflake.yml
⚡ python-black.yml
⚡ python-build-sdist.yml
⚡ python-build-wheel.yml
⚡ python-import-linter.yml
⚡ python-isort.yml
⚡ python-mypy.yml
⚡ python-pyroma.yml
⚡ python-pytest.yml
⚡ python-setuptools-bdist-wheel.yml
⚡ python-setuptools-sdist.yml
⚡ python-twine-upload.yml
⚡ python-vulture.yml
```
### `fmt`
Normalize the style of your GitLab CI/CD files:
```bash
cici fmt
```
```console
$ cici fmt
.gitlab-ci.yml formatted
```
### `readme`
Generate a README for your pipeline project:
```bash
cici readme
```
To customize the output, copy the default README template to `README.md.j2` in
your project root and modify:
```j2
# {{ name }} pipeline
{%- include "brief.md.j2" %}
{%- include "description.md.j2" %}
{%- include "groups.md.j2" %}
{%- include "targets.md.j2" %}
{%- include "variables.md.j2" %}
```
### `update`
Update to the latest GitLab CI/CD `include` versions available.
```bash
cici update
```
```console
$ cici update
updated buildgarden/pipelines/python to 0.5.1
updated buildgarden/pipelines/gitlab from 0.1.0 to 0.2.2
```
Raw data
{
"_id": null,
"home_page": null,
"name": "cici-tools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "ci, pipeline, python",
"author": null,
"author_email": "Digital Safety Research Institute <contact@dsri.org>",
"download_url": "https://files.pythonhosted.org/packages/3b/dc/bef77e5859191fb44bb81d72fecdb053273ab4aff83c57439a2d8f8d944a/cici_tools-0.8.1.tar.gz",
"platform": null,
"description": "# cici-tools\n\n<!-- BADGIE TIME -->\n\n[](https://gitlab.com/buildgarden/tools/cici-tools/-/commits/main)\n[](https://gitlab.com/buildgarden/tools/cici-tools/-/commits/main)\n[](https://gitlab.com/buildgarden/tools/cici-tools/-/releases)\n[](https://github.com/pre-commit/pre-commit)\n[](https://github.com/prettier/prettier)\n\n<!-- END BADGIE TIME -->\n\nPower tools for CI/CD.\n\n> Do not use this software unless you are an active collaborator on the\n> associated research project.\n>\n> This project is an output of an ongoing, active research project. It is\n> published without warranty, is subject to change at any time, and has not been\n> certified, tested, assessed, or otherwise assured of safety by any person or\n> organization. Use at your own risk.\n\n## Usage\n\n### `bundle`\n\nFlatten `extends` keywords to make zero-dependency GitLab CI/CD files.\n\n```bash\ncici bundle\n```\n\n```console\n$ cici bundle\n\u26a1 python-autoflake.yml\n\u26a1 python-black.yml\n\u26a1 python-build-sdist.yml\n\u26a1 python-build-wheel.yml\n\u26a1 python-import-linter.yml\n\u26a1 python-isort.yml\n\u26a1 python-mypy.yml\n\u26a1 python-pyroma.yml\n\u26a1 python-pytest.yml\n\u26a1 python-setuptools-bdist-wheel.yml\n\u26a1 python-setuptools-sdist.yml\n\u26a1 python-twine-upload.yml\n\u26a1 python-vulture.yml\n```\n\n### `fmt`\n\nNormalize the style of your GitLab CI/CD files:\n\n```bash\ncici fmt\n```\n\n```console\n$ cici fmt\n.gitlab-ci.yml formatted\n```\n\n### `readme`\n\nGenerate a README for your pipeline project:\n\n```bash\ncici readme\n```\n\nTo customize the output, copy the default README template to `README.md.j2` in\nyour project root and modify:\n\n```j2\n# {{ name }} pipeline\n\n{%- include \"brief.md.j2\" %}\n{%- include \"description.md.j2\" %}\n\n{%- include \"groups.md.j2\" %}\n\n{%- include \"targets.md.j2\" %}\n\n{%- include \"variables.md.j2\" %}\n```\n\n### `update`\n\nUpdate to the latest GitLab CI/CD `include` versions available.\n\n```bash\ncici update\n```\n\n```console\n$ cici update\nupdated buildgarden/pipelines/python to 0.5.1\nupdated buildgarden/pipelines/gitlab from 0.1.0 to 0.2.2\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Power tools for CI/CD.",
"version": "0.8.1",
"project_urls": {
"Home": "https://gitlab.com/buildgarden/tools/cici-tools",
"Issues": "https://gitlab.com/buildgarden/tools/cici-tools/-/issues"
},
"split_keywords": [
"ci",
" pipeline",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b71b4e71e757ec6a3adc84ab49b73f25de636772ab392d9311fe10467f53976e",
"md5": "71071af494d7c7672ccc30a15fa80b26",
"sha256": "ce3da6e9a21b1da0425d98cd90953fe8c7b1d22e996b4df569d0caf22512068d"
},
"downloads": -1,
"filename": "cici_tools-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "71071af494d7c7672ccc30a15fa80b26",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 37393,
"upload_time": "2024-12-17T05:32:16",
"upload_time_iso_8601": "2024-12-17T05:32:16.173988Z",
"url": "https://files.pythonhosted.org/packages/b7/1b/4e71e757ec6a3adc84ab49b73f25de636772ab392d9311fe10467f53976e/cici_tools-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3bdcbef77e5859191fb44bb81d72fecdb053273ab4aff83c57439a2d8f8d944a",
"md5": "0f0719b93c03541695ab084bcae023d6",
"sha256": "2f7c1b06a1b30436478ecdcaabd6c341fa8f41cba9485c1bb3fed7173885ef69"
},
"downloads": -1,
"filename": "cici_tools-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "0f0719b93c03541695ab084bcae023d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 36035,
"upload_time": "2024-12-17T05:32:17",
"upload_time_iso_8601": "2024-12-17T05:32:17.471818Z",
"url": "https://files.pythonhosted.org/packages/3b/dc/bef77e5859191fb44bb81d72fecdb053273ab4aff83c57439a2d8f8d944a/cici_tools-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 05:32:17",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "buildgarden",
"gitlab_project": "tools",
"lcname": "cici-tools"
}
