jenkinsctl 0.0.7__tar.gz → 0.1.0__tar.gz

{jenkinsctl-0.0.7 → jenkinsctl-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: jenkinsctl
-Version: 0.0.7
+Version: 0.1.0
 Summary: Build Jenkins jobs effortlessly using a single command. 🚀
 Author-email: Aman Shaw <amanshaw4511@protonmail.com>
 Project-URL: Homepage, https://github.com/amanshaw4511/jenkinsctl
@@ -18,7 +18,7 @@ Requires-Dist: dynaconf
 Requires-Dist: pyyaml
 Requires-Dist: argcomplete
 
-# jenkinsctl
+# jenkinsctl [![PyPI version](https://badge.fury.io/py/jenkinsctl.svg)](https://badge.fury.io/py/jenkinsctl) [![Downloads](https://static.pepy.tech/badge/jenkinsctl/week)](https://pepy.tech/project/jenkinsctl)
 Build Jenkins jobs effortlessly using a single command. 🚀
 
 ## Installation 📦
@@ -37,6 +37,7 @@ export JENKINS_API_KEY=21df49caf41726094323b803a6de363eae
 ```
 Adjust the values to match your Jenkins server's URL, your username, and the corresponding API key. This configuration is essential for jenkinsctl to interact with Jenkins and execute tasks efficiently.
 
+How to Get the API Token: https://www.baeldung.com/ops/jenkins-api-token
 ## Usage 🤖
 ```sh
 $ jenkinsctl --help
@@ -95,7 +96,7 @@ This command executes the job based on the specified YAML configuration.
 
 ### Overriding Specific Parameter from Configuration
 ```sh
-jenkinsctl build -f my_job.yaml --param param2=11 --param3=false
+jenkinsctl build -f my_job.yaml --param param2=11 --param param3=false
 ```
 This command will override the value of `param2` and `param3` from original configuration file `my_job.yaml`, passing an effective configuration as follows to run jenkin job :
 ```yaml
@@ -105,6 +106,9 @@ params:
     param2: 11
     param3: false
 ```
+.. |PyPI-Downloads| image:: https://img.shields.io/pypi/dm/shtab.svg?label=pypi%20downloads&logo=PyPI&logoColor=white
+   :target: https://pepy.tech/project/shtab
+   :alt: Downloads
 
 ### Generating Config from Existing Builds
 Capture and reproduce configurations from previous Jenkins builds.

{jenkinsctl-0.0.7 → jenkinsctl-0.1.0}/README.md

@@ -1,4 +1,4 @@
-# jenkinsctl
+# jenkinsctl [![PyPI version](https://badge.fury.io/py/jenkinsctl.svg)](https://badge.fury.io/py/jenkinsctl) [![Downloads](https://static.pepy.tech/badge/jenkinsctl/week)](https://pepy.tech/project/jenkinsctl)
 Build Jenkins jobs effortlessly using a single command. 🚀
 
 ## Installation 📦
@@ -17,6 +17,7 @@ export JENKINS_API_KEY=21df49caf41726094323b803a6de363eae
 ```
 Adjust the values to match your Jenkins server's URL, your username, and the corresponding API key. This configuration is essential for jenkinsctl to interact with Jenkins and execute tasks efficiently.
 
+How to Get the API Token: https://www.baeldung.com/ops/jenkins-api-token
 ## Usage 🤖
 ```sh
 $ jenkinsctl --help
@@ -75,7 +76,7 @@ This command executes the job based on the specified YAML configuration.
 
 ### Overriding Specific Parameter from Configuration
 ```sh
-jenkinsctl build -f my_job.yaml --param param2=11 --param3=false
+jenkinsctl build -f my_job.yaml --param param2=11 --param param3=false
 ```
 This command will override the value of `param2` and `param3` from original configuration file `my_job.yaml`, passing an effective configuration as follows to run jenkin job :
 ```yaml
@@ -85,10 +86,13 @@ params:
     param2: 11
     param3: false
 ```
+.. |PyPI-Downloads| image:: https://img.shields.io/pypi/dm/shtab.svg?label=pypi%20downloads&logo=PyPI&logoColor=white
+   :target: https://pepy.tech/project/shtab
+   :alt: Downloads
 
 ### Generating Config from Existing Builds
 Capture and reproduce configurations from previous Jenkins builds.
 To generate a YAML configuration file from a specific build (e.g. 2nd build) of a job (e.g., `my_job`), use the following command:
 ```sh
 jenkinsctl config my_job 2 > my_job.yaml
-```
+```

jenkinsctl-0.1.0/jenkinsctl/commons.py

@@ -0,0 +1,8 @@
+
+
+def use_vprint(verbose_flag):
+    def vprint(*args, **kwargs):
+        if verbose_flag:
+            print(*args, **kwargs)
+
+    return vprint

{jenkinsctl-0.0.7 → jenkinsctl-0.1.0}/jenkinsctl/jbuild.py

@@ -6,6 +6,8 @@ import sys
 import yaml
 from threading import Thread
 
+from .commons import use_vprint
+
 
 def handle_build_command(args):
     vprint = use_vprint(args.verbose)
@@ -17,14 +19,6 @@ def handle_build_command(args):
     create_build(args.client, conf, args.suppress_logs, vprint)
 
 
-def use_vprint(verbose_flag):
-    def vprint(*args, **kwargs):
-        if verbose_flag:
-            print(*args, **kwargs)
-
-    return vprint
-
-
 def get_config_from_yaml(file):
     config_data = None
     try:
@@ -111,9 +105,11 @@ def create_build(client, conf, suppress_logs: bool, vprint=print):
 
     approve_pending_input_thread.join()
 
+    if build.result == "FAILURE":
+        print(f"FAILED... build number : {build_number}")
+        sys.exit(1)
+
     if not suppress_logs:
         print(f"FINISHED... build number : {build_number}")
     else:
         print(build_number)
-
-    return build_number

{jenkinsctl-0.0.7 → jenkinsctl-0.1.0}/jenkinsctl/jenkins.py

@@ -45,7 +45,8 @@ def add_get_config_subparser(subparsers):
     subparser = subparsers.add_parser("config", help="get config of a build")
     subparser.set_defaults(func=handle_get_config, client=get_client)
     subparser.add_argument("job_name")
-    subparser.add_argument("build_no", type=int)
+    subparser.add_argument("build_no", type=int, nargs="?")
+    subparser.add_argument("-v", "--verbose", action="store_true")
 
 
 if __name__ == '__main__':

jenkinsctl-0.1.0/jenkinsctl/jget_config.py

@@ -0,0 +1,41 @@
+import yaml
+
+from .commons import use_vprint
+
+
+def handle_get_config(args):
+    vprint = use_vprint(args.verbose)
+    vprint(f"Passed args : {vars(args)}")
+
+    client = args.client()
+
+    job_name = args.job_name
+
+    build = get_build(client, vprint, job_name, args.build_no)
+
+    params = get_params(build)
+
+    print(to_yaml(job_name, params))
+
+
+def get_build(client, vprint, job_name, build_no):
+    job = client.get_job(job_name)
+
+    final_build_no = get_last_build_no(job) if build_no is None else build_no
+    vprint(f"final build no {final_build_no}")
+
+    build = job.get(final_build_no)
+
+    return build
+
+
+def get_last_build_no(job):
+    return job.get_last_build().number
+
+
+def get_params(build):
+    return dict([(param.name, param.value) for param in build.get_parameters()])
+
+
+def to_yaml(job_name, params):
+    return yaml.dump({"job": job_name, "params": params})

{jenkinsctl-0.0.7 → jenkinsctl-0.1.0}/jenkinsctl.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: jenkinsctl
-Version: 0.0.7
+Version: 0.1.0
 Summary: Build Jenkins jobs effortlessly using a single command. 🚀
 Author-email: Aman Shaw <amanshaw4511@protonmail.com>
 Project-URL: Homepage, https://github.com/amanshaw4511/jenkinsctl
@@ -18,7 +18,7 @@ Requires-Dist: dynaconf
 Requires-Dist: pyyaml
 Requires-Dist: argcomplete
 
-# jenkinsctl
+# jenkinsctl [![PyPI version](https://badge.fury.io/py/jenkinsctl.svg)](https://badge.fury.io/py/jenkinsctl) [![Downloads](https://static.pepy.tech/badge/jenkinsctl/week)](https://pepy.tech/project/jenkinsctl)
 Build Jenkins jobs effortlessly using a single command. 🚀
 
 ## Installation 📦
@@ -37,6 +37,7 @@ export JENKINS_API_KEY=21df49caf41726094323b803a6de363eae
 ```
 Adjust the values to match your Jenkins server's URL, your username, and the corresponding API key. This configuration is essential for jenkinsctl to interact with Jenkins and execute tasks efficiently.
 
+How to Get the API Token: https://www.baeldung.com/ops/jenkins-api-token
 ## Usage 🤖
 ```sh
 $ jenkinsctl --help
@@ -95,7 +96,7 @@ This command executes the job based on the specified YAML configuration.
 
 ### Overriding Specific Parameter from Configuration
 ```sh
-jenkinsctl build -f my_job.yaml --param param2=11 --param3=false
+jenkinsctl build -f my_job.yaml --param param2=11 --param param3=false
 ```
 This command will override the value of `param2` and `param3` from original configuration file `my_job.yaml`, passing an effective configuration as follows to run jenkin job :
 ```yaml
@@ -105,6 +106,9 @@ params:
     param2: 11
     param3: false
 ```
+.. |PyPI-Downloads| image:: https://img.shields.io/pypi/dm/shtab.svg?label=pypi%20downloads&logo=PyPI&logoColor=white
+   :target: https://pepy.tech/project/shtab
+   :alt: Downloads
 
 ### Generating Config from Existing Builds
 Capture and reproduce configurations from previous Jenkins builds.

{jenkinsctl-0.0.7 → jenkinsctl-0.1.0}/jenkinsctl.egg-info/SOURCES.txt

@@ -2,6 +2,7 @@ LICENSE
 README.md
 pyproject.toml
 jenkinsctl/__init__.py
+jenkinsctl/commons.py
 jenkinsctl/config.py
 jenkinsctl/jbuild.py
 jenkinsctl/jenkins.py

{jenkinsctl-0.0.7 → jenkinsctl-0.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "jenkinsctl"
-version = "v0.0.7"
+version = "v0.1.0"
 dependencies = ["api4jenkins", "dynaconf", "pyyaml", "argcomplete"]
 authors = [{ name = "Aman Shaw", email = "amanshaw4511@protonmail.com" }]
 description = "Build Jenkins jobs effortlessly using a single command. 🚀"

jenkinsctl-0.0.7/jenkinsctl/jget_config.py

@@ -1,19 +0,0 @@
-import yaml
-
-def handle_get_config(args):
-    # print(args)
-    client = args.client()
-    job_name = args.job_name
-
-    job = client.get_job(job_name)
-    build = job.get(int(args.build_no))
-    params = get_params(build)
-    print(to_yaml(job_name, params))
-
-
-def get_params(build):
-    return dict([ (param.name, param.value) for param in build.get_parameters() ])
-
-def to_yaml(job_name, params):
-    return yaml.dump( { "job" : job_name, "params": params})
-