| Name | t1cicd JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-11-19 17:39:38 |
| maintainer | None |
| docs_url | None |
| author | Your Name |
| requires_python | <4.0,>=3.9 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# T1-CICD
## High-Level Design
## Sequence Diagram
### Pipeline Run
## Components
### CLI
#### cicd
- Usage: cicd [OPTIONS] COMMAND [ARGS]...
This command is the entry point to the CLI. It can be used to check the
config file, perform a dry run, or run a pipeline.
- Options:
- -c, --check Check config file.
- -dr, --dryrun Dry run.
- -cf, --config-file TEXT Path to config file.
- -h, --help Show help message and exit
- Commands:
- report Show a report of a pipeline.
- run Run a specific pipeline or override the config file in a repository.
- stop Stop a specific pipeline in a repository.
##### cicd report
- Usage: cicd report [OPTIONS]
Show a report of a pipeline.
If no options are specified, show a report of all pipelines.
If --pipeline is specified, show a report of the pipeline.
If --run is specified, show a report of the run.
If --stage is specified, show a report of the stage.
If --job is specified, show a report of the job.
- Options:
- -r, --repo TEXT Repository path. [required]
- -l, --local Run locally.
- -p, --pipeline TEXT Pipeline name.
- -rn, --run TEXT Run number.
- -s, --stage TEXT Stage name.
- -j, --job TEXT Job name.
- -h, --help Show help message and exit.
##### cicd run
- Usage: cicd run [OPTIONS]
Run a specific pipeline or override the config file in a repository.
If --override is specified, override the config file with the new config.
if either --pipeline or --file is specified, run the specific pipeline.
Otherwise, run all pipelines in the repository.
- Options:
- -r, --repo TEXT Repository path. [default: (current local directory)]
- -l, --local Run locally.
- -b, --branch TEXT Branch name. [default: (main branch)]
- -c, --commit TEXT Commit hash. [default: (the latest commit)]
- -p, --pipeline TEXT Pipeline name.
- -f, --file TEXT Path to config file.
- -o, --override TEXT Override config file.
- -h, --help Show this message and exit.
##### cicd stop
- Usage: cicd stop [OPTIONS]
Stop a specific pipeline in a repository.
if either --pipeline or --file is specified, stop the specific pipeline.
Otherwise, stop all pipelines in the repository.
- Options:
- -r, --repo TEXT Repository path. [default: (current local directory)]
- -l, --local Run locally.
- -b, --branch TEXT Branch name. [default: (main branch)]
- -c, --commit TEXT Commit hash. [default: (the latest commit)]
- -p, --pipeline TEXT Pipeline name.
- -f, --file TEXT Path to config file.
- -h, --help Show help message and exit.
### Rest API
## Getting Started
#### Build the project
```bash
$ poetry install
```
#### Run server
```bash
$ poetry run server # It will be packaged and added to system env.
```
#### Run CLI
```bash
$ poetry run cicd # It will be packaged and added to system env.
```
#### Run tests
```bash
$ poetry run pytest
```
#### Run test coverage
```bash
$ poetry run coverage report
```
#### Run static analysis
```bash
$ poetry run pylint src
```
#### Generate documents
```bash
$ poetry run pdoc src
```
Raw data
{
"_id": null,
"home_page": null,
"name": "t1cicd",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/ec/c3/7970e9c2517e25e0d1388ef1d6a8a31a01445bb5ba664c17b020f9cb2314/t1cicd-0.1.1.tar.gz",
"platform": null,
"description": "# T1-CICD\n\n## High-Level Design\n\n\n\n## Sequence Diagram\n\n### Pipeline Run\n\n\n\n## Components\n\n### CLI\n\n#### cicd\n\n- Usage: cicd [OPTIONS] COMMAND [ARGS]...\n\n This command is the entry point to the CLI. It can be used to check the\n config file, perform a dry run, or run a pipeline.\n\n - Options:\n - -c, --check Check config file.\n - -dr, --dryrun Dry run.\n - -cf, --config-file TEXT Path to config file.\n - -h, --help Show help message and exit\n - Commands:\n - report Show a report of a pipeline.\n - run Run a specific pipeline or override the config file in a repository.\n - stop Stop a specific pipeline in a repository.\n\n##### cicd report\n\n- Usage: cicd report [OPTIONS]\n\n \t Show a report of a pipeline.\n \t\n \t If no options are specified, show a report of all pipelines.\n \t\n \t If --pipeline is specified, show a report of the pipeline.\n \t\n \t If --run is specified, show a report of the run.\n \t\n \tIf --stage is specified, show a report of the stage.\n \t\n \tIf --job is specified, show a report of the job.\n\n- Options:\n - -r, --repo TEXT Repository path. [required]\n - -l, --local Run locally.\n - -p, --pipeline TEXT Pipeline name.\n - -rn, --run TEXT Run number.\n - -s, --stage TEXT Stage name.\n - -j, --job TEXT Job name.\n - -h, --help Show help message and exit.\n\n##### cicd run\n\n- Usage: cicd run [OPTIONS]\n\n Run a specific pipeline or override the config file in a repository.\n \n If --override is specified, override the config file with the new config.\n \n if either --pipeline or --file is specified, run the specific pipeline.\n \n Otherwise, run all pipelines in the repository.\n \n- Options:\n\n - -r, --repo TEXT Repository path. [default: (current local directory)]\n - -l, --local Run locally.\n - -b, --branch TEXT Branch name. [default: (main branch)]\n - -c, --commit TEXT Commit hash. [default: (the latest commit)]\n - -p, --pipeline TEXT Pipeline name.\n - -f, --file TEXT Path to config file.\n - -o, --override TEXT Override config file.\n - -h, --help Show this message and exit.\n\n\n##### cicd stop\n\n- Usage: cicd stop [OPTIONS]\n\n \tStop a specific pipeline in a repository.\n if either --pipeline or --file is specified, stop the specific pipeline.\n Otherwise, stop all pipelines in the repository.\n\n- Options:\n - -r, --repo TEXT Repository path. [default: (current local directory)]\n - -l, --local Run locally.\n - -b, --branch TEXT Branch name. [default: (main branch)]\n - -c, --commit TEXT Commit hash. [default: (the latest commit)]\n - -p, --pipeline TEXT Pipeline name.\n - -f, --file TEXT Path to config file.\n - -h, --help Show help message and exit.\n\n### Rest API\n\n\n\n## Getting Started\n\n#### Build the project\n\n```bash\n$ poetry install\n```\n\n#### Run server\n\n```bash\n$ poetry run server # It will be packaged and added to system env.\n```\n\n#### Run CLI\n\n```bash\n$ poetry run cicd # It will be packaged and added to system env. \n```\n\n#### Run tests\n\n```bash\n$ poetry run pytest\n```\n\n#### Run test coverage\n\n```bash\n$ poetry run coverage report\n```\n\n#### Run static analysis\n\n```bash\n$ poetry run pylint src\n```\n\n#### Generate documents\n\n```bash\n$ poetry run pdoc src\n```\n\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.1.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b916dd80e4e4e26d218c8887b140ac964c4d55bf4ab4548753fd9fbfac07699",
"md5": "78523d9b7959ccd8cf15b5e59787cdfe",
"sha256": "882fe7525ccd0769fc9c40e6355ffa29b26dd7522226c89f59bc8ca1b3c49357"
},
"downloads": -1,
"filename": "t1cicd-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "78523d9b7959ccd8cf15b5e59787cdfe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 49539,
"upload_time": "2024-11-19T17:39:37",
"upload_time_iso_8601": "2024-11-19T17:39:37.578823Z",
"url": "https://files.pythonhosted.org/packages/2b/91/6dd80e4e4e26d218c8887b140ac964c4d55bf4ab4548753fd9fbfac07699/t1cicd-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ecc37970e9c2517e25e0d1388ef1d6a8a31a01445bb5ba664c17b020f9cb2314",
"md5": "9a4dbf81a9a45f27c02b179960ca354f",
"sha256": "ffeef3f19dbad5d360aecdccfaa9d385fefe37e08b836a7558463ca21987bdab"
},
"downloads": -1,
"filename": "t1cicd-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "9a4dbf81a9a45f27c02b179960ca354f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 32822,
"upload_time": "2024-11-19T17:39:38",
"upload_time_iso_8601": "2024-11-19T17:39:38.719255Z",
"url": "https://files.pythonhosted.org/packages/ec/c3/7970e9c2517e25e0d1388ef1d6a8a31a01445bb5ba664c17b020f9cb2314/t1cicd-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 17:39:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "t1cicd"
}
