jenkinsapi 0.3.15.dev2__tar.gz → 0.3.15.dev8__tar.gz

jenkinsapi-0.3.15.dev8/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,29 @@
+##### ISSUE TYPE
+<!--- Pick one below and delete the rest: -->
+ - Bug Report
+ - Feature Idea
+ - How to...
+
+##### Jenkinsapi VERSION
+
+##### Jenkins VERSION
+
+##### SUMMARY
+<!--- Explain the problem briefly -->
+
+##### EXPECTED RESULTS
+<!--- What did you expect to happen when running the steps above? -->
+
+##### ACTUAL RESULTS
+<!--- What actually happened? If possible run with extra verbosity (-vvvv) -->
+
+##### USEFUL INFORMATION
+<!---
+For bugs, show exactly how to reproduce the problem.
+For new features, show how the feature would be used.
+-->
+
+<!--- Paste example code and full stacktrace below -->
+```
+
+```

jenkinsapi-0.3.15.dev8/.github/dependabot.yml

@@ -0,0 +1,15 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

jenkinsapi-0.3.15.dev8/.github/stale.yml

@@ -0,0 +1,64 @@
+# Configuration for probot-stale - https://github.com/probot/stale
+
+# Number of days of inactivity before an Issue or Pull Request becomes stale
+daysUntilStale: 60
+
+# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
+# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
+daysUntilClose: 7
+
+# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
+onlyLabels: []
+
+# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
+exemptLabels:
+  - pinned
+  - security
+  - "[Status] Maybe Later"
+  - "feature request"
+  - "help wanted"
+  - "improvement request"
+
+# Set to true to ignore issues in a project (defaults to false)
+exemptProjects: false
+
+# Set to true to ignore issues in a milestone (defaults to false)
+exemptMilestones: false
+
+# Set to true to ignore issues with an assignee (defaults to false)
+exemptAssignees: false
+
+# Label to use when marking as stale
+staleLabel: stale
+
+# Comment to post when marking as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+
+# Comment to post when removing the stale label.
+# unmarkComment: >
+#   Your comment here.
+
+# Comment to post when closing a stale Issue or Pull Request.
+closeComment: >
+  Closed due to inactivity
+
+# Limit the number of actions per hour, from 1-30. Default is 30
+limitPerRun: 30
+
+# Limit to only `issues` or `pulls`
+# only: issues
+
+# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
+# pulls:
+#   daysUntilStale: 30
+#   markComment: >
+#     This pull request has been automatically marked as stale because it has not had
+#     recent activity. It will be closed if no further activity occurs. Thank you
+#     for your contributions.
+
+# issues:
+#   exemptLabels:
+#     - confirmed

jenkinsapi-0.3.15.dev8/.github/workflows/build-docs.yml

@@ -0,0 +1,48 @@
+name: Sphinx build
+
+on:  # yamllint disable-line rule:truthy
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  sphinx-build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+      pages: write
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update; sudo apt-get install libkrb5-dev gcc
+
+      - name: Build HTML
+        run: make
+        working-directory: ./doc
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-docs
+          path: ./doc/html/
+
+      - name: Deploy Master Docs to GitHub Pages
+        if: ${{ github.ref == 'refs/heads/master' }}
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doc/html
+          publish_branch: gh-pages
+          keep_files: false

jenkinsapi-0.3.15.dev8/.github/workflows/python-package.yml

@@ -0,0 +1,107 @@
+name: CI_TEST
+
+on:
+  push:
+    branches: [ "master" ]
+    paths:
+      - '**.py'
+      - '**.yml'
+  pull_request:
+    branches: [ "master" ]
+  workflow_dispatch: # allow manual run
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.13"]
+        token: ["stable"]
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v5
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install python
+      run: uv python install
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get update; sudo apt-get install libkrb5-dev gcc
+
+    - name: Lint with ruff
+      run: |
+        uv run ruff check jenkinsapi/ --output-format full
+
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        token: ["stable"]
+
+    steps:
+    - name: Harden Runner
+      uses: step-security/harden-runner@v2.13.0
+      with:
+        egress-policy: audit
+        allowed-endpoints: >
+          azure.archive.ubuntu.com:80
+          esm.ubuntu.com:443
+          files.pythonhosted.org:443
+          ftp-chi.osuosl.org:443
+          ftp-nyc.osuosl.org:443
+          get.jenkins.io:443
+          github.com:443
+          api.github.com:443
+          int.api.stepsecurity.io:443
+          mirror.xmission.com:443
+          motd.ubuntu.com:443
+          packages.microsoft.com:443
+          ppa.launchpadcontent.net:443
+          pypi.org:443
+          updates.jenkins-ci.org:80
+          updates.jenkins.io:443
+          mirrors.updates.jenkins.io:443
+          updates.jenkins.io:80
+
+    - name: Checkout
+      uses: actions/checkout@v5
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install python
+      run: uv python install
+
+    - name: setup java 21
+      uses: actions/setup-java@v5
+      with:
+        java-version: '21'
+        distribution: 'temurin'
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get update; sudo apt-get install libkrb5-dev gcc
+
+    - name: Test with pytest
+      env:
+        JENKINS_VERSION: ${{ matrix.token }}
+      run: |
+        uv run pytest -sv --cov=jenkinsapi --cov-report=term-missing --cov-report=xml jenkinsapi_tests

jenkinsapi-0.3.15.dev8/.github/workflows/release.yml

@@ -0,0 +1,83 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+permissions:
+    contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.13"
+
+      - name: Set pyproject.toml version from release tag
+        run: |
+          uv version "${GITHUB_REF##*/}"
+
+      - name: Install python
+        run: uv python install
+
+      - name: build
+        run: uv build
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: package
+          path: dist/
+          retention-days: 7
+          if-no-files-found: error
+
+  pypi:
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs: [build]
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment:
+        name: gha
+        url: https://pypi.org/project/jenkinsapi/
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v5
+        with:
+          name: package
+          path: dist
+
+      - name: Show tree
+        run: tree
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  asset:
+    needs: [build]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v5
+        with:
+          name: package
+          path: dist
+
+      - name: Show tree
+        run: tree
+
+      - name: Add release asset
+        uses: softprops/action-gh-release@72f2c25fcb47643c292f7107632f7a47c1df5cd8
+        with:
+          tag_name: ${{ github.event.release.tag_name }}
+          fail_on_unmatched_files: true
+          files: |
+            dist/*

jenkinsapi-0.3.15.dev8/.gitignore

@@ -0,0 +1,33 @@
+.svn
+.project
+.pydevproject
+*.pyc
+*.egg-info
+/build
+/dist
+.settings
+*.DS_Store
+localinstance_files/
+.coverage/
+.coverage
+nosetests.xml
+coverage*/
+.idea/
+include/
+lib/
+*.egg
+.tox/*
+*.sw?
+/jenkinsapi_tests/systests/coverage.xml
+/.cache
+/AUTHORS
+/ChangeLog
+.pytest_cache
+.eggs
+coverage.xml
+.venv/
+.vscode/
+*.war
+venv/
+tags
+.pytype/

jenkinsapi-0.3.15.dev8/.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+      - id: fix-byte-order-marker
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-vcs-permalinks
+      - id: debug-statements
+      - id: check-yaml
+        files: .*\.(yaml|yml)$
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.12 # Use latest Ruff version
+    hooks:
+      - id: ruff
+      - id: ruff-format

jenkinsapi-0.3.15.dev8/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+- node class: add ability to add, modify, and delete node labels
+
+## 3.3.13
+
+- docs: fix doc and add autobuild
+- feature: add launch method to Node class (#849)
+- convert to using ruff for linting (#895)
+- update harden runner (#894)
+- change url to pull jenkins.war file (#893)
+- Make sure to filter warnings to errors (#868)
+- Revert "dependabot" (#888)
+- dependabot (#887)
+- makefile: update for uv compatibility (#886)
+- update pre-commit versions (#885)
+- remove deprecated setup (#884)
+- housekeeping: readme, license, pyproject.toml (#881)
+- update install commands to use uv (#882)
+- ci: update java to 21 (#883)
+- convert to uv and pyproject.toml (#879)
+- ci: update checkout to v4 (#880)
+- ci: remove apt-get update, install, and pip upgrade as unnecessary (#878)
+- docs: fix build (#876)
+- add support for 3.12 and 3.13 (#877)
+- Correctly specify python version (#858)
+- Merge pull request #874 from clintonsteiner/fixSeveralCiIssues
+- ci: add in missing plugins
+- ci: harden runner - set to audit for now
+- ci: add mirrors to harden whitelist
+- test_build: fix failing tests
+- ci: tests fail because jenkins requires java 17 - setup in github action
+- makefile: fix py.test according to pytest documentation
+- ci: fix issue causing runner to crash in setup
+- Merge pull request #853 from clintonsteiner/updateReadme
+-  Readme Updates: Remove redundant words, move install and example to top
+- [pre-commit.ci] auto fixes from pre-commit.com hooks
+- fix: jenkinsapi crashing jenkins_is_unavaiable
+- [pre-commit.ci] auto fixes from pre-commit.com hooks
+- Support for using unicode characters in update_config
+- Decode content using the encoding specified in the response
+- Fixing plugin dependencies
+- Fix console scripts in pyproject.toml
+- Added Python typing hints to most of the code
+- Bump version
+- Move utils into jenkinsapi.utils module
+- Remove blank line
+- Update Build object docs
+- Add pyproject.toml
+- Rename Travis and Tox files
+- Flake8 fixes
+- [pre-commit.ci] auto fixes from pre-commit.com hooks
+- Do not call Jenkins site when testing plugins
+- Download Jenkins silently and improve plugin downloads
+- Fix failing tests and commented ones not working
+- Add flake8 to test requirements
+- Install test dependencies
+- Install krb and pytest-cov in workflow
+- Add Github action
+- Pyflake8 fixes
+- Add pre-commit.ci configuration
+- Add debug logs in Queue.block_until_building (#745)
+- Fixing retrying logic by introducing a max_retries param (#739)
+- Add quiet period parameter to job invoke (#758)
+- useCrumbs -> use_crumbs #755 (#756)
+- job.py: manage scm data for multibranch pipelines (#742)
+
+## 0.3.11 - Oct 31, 2019

jenkinsapi-0.3.15.dev8/Makefile

@@ -0,0 +1,19 @@
+.PHONY: test lint tox coverage dist
+
+test:
+	uv run pytest -sv jenkinsapi_tests
+
+lint:
+	uv run pycodestyle
+	uv run pylint jenkinsapi/*.py
+	uv run flake8 jenkinsapi/ --count --select=E9,F63,F7,F82 --ignore F821,W503,W504 --show-source --statistics
+	uv run flake8 jenkinsapi/ --count --exit-zero --max-complexity=10 --max-line-length=79 --statistics
+
+tox:
+	tox
+
+dist:
+	uv build
+
+coverage:
+	uv run pytest -sv --cov=jenkinsapi --cov-report=term-missing --cov-report=xml jenkinsapi_tests

{jenkinsapi-0.3.15.dev2 → jenkinsapi-0.3.15.dev8}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: jenkinsapi
-Version: 0.3.15.dev2
+Version: 0.3.15.dev8
 Summary: A Python API for accessing resources on a Jenkins continuous-integration server.
 Author-email: Salim Fadhley <salimfadhley@gmail.com>, Aleksey Maksimov <ctpeko3a@gmail.com>, Clinton Steiner <clintonsteiner@gmail.com>
 Maintainer-email: Aleksey Maksimov <ctpeko3a@gmail.com>, Clinton Steiner <clintonsteiner@gmail.com>
-Requires-Python: >=3.9
-Description-Content-Type: text/x-rst
+License: MIT license
+License-File: LICENSE
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -23,9 +23,10 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: Utilities
-License-File: LICENSE
+Requires-Python: >=3.9
 Requires-Dist: pytz>=2014.4
 Requires-Dist: requests>=2.3.0
+Description-Content-Type: text/x-rst
 
 Jenkinsapi
 ==========
@@ -169,4 +170,3 @@ Project Contributors
 Please do not contact these contributors directly for support questions! Use the GitHub tracker instead.
 
 .. _Java: https://www.oracle.com/java/technologies/downloads/#java21
-

jenkinsapi-0.3.15.dev8/TODO

@@ -0,0 +1,6 @@
+TODO:
+
+* Clean up the fingerprint code
+* Clean up the resultset and results code
+* Add support for Jenkins 2.x features
+* Improve speed for large Jenkins installations

jenkinsapi-0.3.15.dev8/bin/pipelint

@@ -0,0 +1,22 @@
+#!/bin/bash
+set -eo pipefail
+
+INPUT=/dev/stdin
+if [ -t 0 ]; then
+    if [ "$#" -ne 1 ]; then
+        echo "ERROR: Illegal number of parameters."
+        echo "INFO:  Use 'pipefail Jenkinsfile' or 'cat Jenkinsfile | pipefail'"
+        exit 1
+    fi
+    INPUT=$1
+fi
+# put credentials inside ~/.netrc
+# define JENKINS_URL in your user profile
+JENKINS_URL=${JENKINS_URL:-http://localhost:8080}
+
+# failure to get crumb is ignored as this may be diabled on the server side
+CRUMB="-H `curl -nfs "$JENKINS_URL/crumbIssuer/api/xml?xpath=concat(//crumbRequestField,%22:%22,//crumb)"`" || CRUMB=''
+
+# The tee+grep trick assures that the exit code is 0 only if the server replied with "successfully validated"
+curl -nfs -X POST $CRUMB -F "jenkinsfile=<-" $JENKINS_URL/pipeline-model-converter/validate <$INPUT \
+  | tee >(cat 1>&2) | grep 'successfully validated' >/dev/null

jenkinsapi-0.3.15.dev8/doc/.gitignore

@@ -0,0 +1,4 @@
+/**/html
+/docs_html.zip
+/ html
+/build

jenkinsapi-0.3.15.dev8/doc/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+Contributing
+============
+
+The JenkinsAPI project welcomes contributions via GitHub. Please bear in mind the following guidelines when preparing your pull-request.
+
+Pre-commit
+----------
+Ensure pre-commit has been setup prior to comitting
+
+Build the Docs
+--------------
+From within doc: make && python -m http.server --directory html
+
+Python compatibility
+--------------------
+
+The project currently targets Python 3.9+.
+
+Code formatting
+---------------
+
+The project follows strict PEP8 guidelines. Please use a tool like black to format your code before submitting a pull request. Tell black to use 79 characters per line (black -l 79).
+
+Test Driven Development
+-----------------------
+
+Please do not submit pull requests without tests. That's really important. Our project is all about test-driven development. It would be embarrasing if our project failed because of a lack of tests!
+
+You might want to follow a typical test driven development cycle: http://en.wikipedia.org/wiki/Test-driven_development
+
+Put simply: Write your tests first and only implement features required to make your tests pass. Do not let your implementation get ahead of your tests.
+
+Features implemented without tests will be removed. Unmaintained features (which break because of changes in Jenkins) will also be removed.
+
+Check the CI status before comitting
+------------------------------------
+
+Project uses Github Actions, please verify that your branch passes all tests before making a pull request.
+
+Any problems?
+-------------
+
+If you are stuck on something, please post to the issue tracker. Do not contact the developers directly.

jenkinsapi-0.3.15.dev8/doc/Makefile

@@ -0,0 +1,17 @@
+SPHINXBUILD   ?= uv run sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = html
+
+.PHONY: all clean html
+
+all: clean html
+
+html:
+	uv sync --group docs
+	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)"
+
+clean:
+	rm -rf ${BUILDDIR}/*
+
+run:
+	uv run python -m http.server --directory "${BUILDDIR}"