Skip to main content

No project description provided

Project description

T1-CICD

High-Level Design

High-Level Design

Sequence Diagram

Pipeline Run

High-Level Design

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

1729643497158

Getting Started

Build the project

$ poetry install

Run server

$ poetry run server # It will be packaged and added to system env.

Run CLI

$ poetry run cicd # It will be packaged and added to system env. 

Run tests

$ poetry run pytest

Run test coverage

$ poetry run coverage report

Run static analysis

$ poetry run pylint src

Generate documents

$ poetry run pdoc src

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

t1cicd-0.1.1.tar.gz (32.8 kB view details)

Uploaded Source

Built Distribution

t1cicd-0.1.1-py3-none-any.whl (49.5 kB view details)

Uploaded Python 3

File details

Details for the file t1cicd-0.1.1.tar.gz.

File metadata

  • Download URL: t1cicd-0.1.1.tar.gz
  • Upload date:
  • Size: 32.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.13.0 Darwin/23.6.0

File hashes

Hashes for t1cicd-0.1.1.tar.gz
Algorithm Hash digest
SHA256 ffeef3f19dbad5d360aecdccfaa9d385fefe37e08b836a7558463ca21987bdab
MD5 9a4dbf81a9a45f27c02b179960ca354f
BLAKE2b-256 ecc37970e9c2517e25e0d1388ef1d6a8a31a01445bb5ba664c17b020f9cb2314

See more details on using hashes here.

File details

Details for the file t1cicd-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: t1cicd-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 49.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.13.0 Darwin/23.6.0

File hashes

Hashes for t1cicd-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 882fe7525ccd0769fc9c40e6355ffa29b26dd7522226c89f59bc8ca1b3c49357
MD5 78523d9b7959ccd8cf15b5e59787cdfe
BLAKE2b-256 2b916dd80e4e4e26d218c8887b140ac964c4d55bf4ab4548753fd9fbfac07699

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page