edx-celeryutils 2.0.0__tar.gz → 2.1.0__tar.gz

edx_celeryutils-2.1.0/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,16 @@
+* edx-celeryutils version:
+* Django version:
+* Python version:
+* Operating System:
+
+### Description
+
+Describe what you were trying to get done.
+Tell us what happened, what went wrong, and what you expected to happen.
+
+### What I Did
+
+```
+Paste the command(s) you ran and the output.
+If there was a crash, please include the traceback here.
+```

edx_celeryutils-2.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,34 @@
+**Description:** Describe in a couple of sentence what this PR adds
+
+**JIRA:** Link to JIRA ticket
+
+**Dependencies:** dependencies on other outstanding PRs, issues, etc. 
+
+**Merge deadline:** List merge deadline (if any)
+
+**Installation instructions:** List any non-trivial installation 
+instructions.
+
+**Testing instructions:**
+
+1. Open page A
+2. Do thing B
+3. Expect C to happen
+4. If D happend instead - check failed.
+
+**Reviewers:**
+- [ ] tag reviwer 
+- [ ] tag reviewer 
+
+**Merge checklist:**
+- [ ] All reviewers approved
+- [ ] CI build is green
+- [ ] Commits are squashed
+- [ ] PR author is listed in AUTHORS
+
+**Post merge:**
+- [ ] Delete working branch (if not needed anymore)
+
+**Author concerns:** List any concerns about this PR - inelegant 
+solutions, hacks, quick-and-dirty implementations, concerns about 
+migrations, etc.

edx_celeryutils-2.1.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+    # Adding new check for github-actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+        interval: "weekly"
+    # Optional: specify reviewers to automatically request review on Dependabot PRs
+    # reviewers:
+    #   - "openedx/xxx"

edx_celeryutils-2.1.0/.github/workflows/add-depr-ticket-to-depr-board.yml

@@ -0,0 +1,19 @@
+# Run the workflow that adds new tickets that are either:
+# - labelled "DEPR"
+# - title starts with "[DEPR]"
+# - body starts with "Proposal Date" (this is the first template field)
+# to the org-wide DEPR project board
+
+name: Add newly created DEPR issues to the DEPR project board
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  routeissue:
+    uses: openedx/.github/.github/workflows/add-depr-ticket-to-depr-board.yml@master
+    secrets:
+      GITHUB_APP_ID: ${{ secrets.GRAPHQL_AUTH_APP_ID }}
+      GITHUB_APP_PRIVATE_KEY: ${{ secrets.GRAPHQL_AUTH_APP_PEM }}
+      SLACK_BOT_TOKEN: ${{ secrets.SLACK_ISSUE_BOT_TOKEN }}

edx_celeryutils-2.1.0/.github/workflows/add-remove-label-on-comment.yml

@@ -0,0 +1,20 @@
+# This workflow runs when a comment is made on the ticket
+# If the comment starts with "label: " it tries to apply
+# the label indicated in rest of comment.
+# If the comment starts with "remove label: ", it tries
+# to remove the indicated label.
+# Note: Labels are allowed to have spaces and this script does
+# not parse spaces (as often a space is legitimate), so the command
+# "label: really long lots of words label" will apply the
+# label "really long lots of words label"
+
+name: Allows for the adding and removing of labels via comment
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  add_remove_labels:
+    uses: openedx/.github/.github/workflows/add-remove-label-on-comment.yml@master
+

edx_celeryutils-2.1.0/.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: Python CI
+
+on:
+  pull_request:
+    branches:
+    - '**'
+  workflow_call:
+
+jobs:
+  run_tests:
+    name: tests
+    runs-on: ${{ matrix.os }}
+    permissions:
+      contents: read
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.12']
+        toxenv: [quality, docs, django42, django52]
+
+    steps:
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+    - name: Install uv
+      uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+      with:
+        enable-cache: true
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install Dependencies
+      run: uv sync --locked --group ci
+
+    - name: Run Tests
+      env:
+        TOXENV: ${{ matrix.toxenv }}
+      run: uv run --locked tox
+
+    - name: Run coverage
+      if: matrix.python-version == '3.12' && matrix.toxenv == 'django42'
+      uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        flags: unittests
+        fail_ci_if_error: true

edx_celeryutils-2.1.0/.github/workflows/commitlint.yml

@@ -0,0 +1,10 @@
+# Run commitlint on the commit messages in a pull request.
+
+name: Lint Commit Messages
+
+on:
+  - pull_request
+
+jobs:
+  commitlint:
+    uses: openedx/.github/.github/workflows/commitlint.yml@master

edx_celeryutils-2.1.0/.github/workflows/release.yml

@@ -0,0 +1,117 @@
+name: Semantic Release
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  # The same aggregate a pull request has to pass, so the release runs exactly
+  # the checks that were required to merge -- and picks up any package added to
+  # ci.yml later without needing a change here.
+  run_ci:
+    uses: ./.github/workflows/ci.yml
+
+  release:
+    # Every package this workflow publishes has to build before we tag
+    # anything. The GitHub release and the PyPI uploads cannot be taken back,
+    # so a package that only fails to build in its publish job would leave the
+    # release half-finished.
+    needs: [run_ci]
+    runs-on: ubuntu-latest
+    if: github.ref_name == 'master'
+    concurrency:
+      group: ${{ github.workflow }}-release-${{ github.ref_name }}
+      cancel-in-progress: false
+
+    permissions:
+      contents: write
+
+    steps:
+      # Note: We checkout the repository at the branch that triggered the workflow.
+      # Python Semantic Release will automatically convert shallow clones to full clones
+      # if needed to ensure proper history evaluation. However, we forcefully reset the
+      # branch to the workflow sha because it is possible that the branch was updated
+      # while the workflow was running, which prevents accidentally releasing un-evaluated
+      # changes.
+      - name: Setup | Checkout Repository on Release Branch
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          ref: ${{ github.ref_name }}
+
+      - name: Setup | Force release branch to be at workflow sha
+        run: |
+          git reset --hard ${{ github.sha }}
+
+      - name: Action | Semantic Version Release
+        id: release
+        # Adjust tag with desired version if applicable.
+        uses: python-semantic-release/python-semantic-release@b700dbeb1f431a0fcc30a79f3f0869407fe07278 # v10.7.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          git_committer_name: "github-actions"
+          git_committer_email: "actions@users.noreply.github.com"
+          changelog: "false"
+          # Commit, tag, push and build, but don't create the GitHub release.
+          # We create it ourselves in the next step so that the distributions
+          # are attached before the release is published. See that step for why.
+          vcs_release: "false"
+
+      # This repo has immutable releases enabled, which freezes a release's
+      # assets the moment it is published, so assets cannot be attached
+      # afterwards. Everything we want on the release has to be built by now
+      # and passed to this one command, which creates the release as a draft,
+      # uploads the assets, and only then publishes it:
+      # https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/immutable-releases
+      - name: Publish | Create GitHub Release with Assets
+        if: steps.release.outputs.released == 'true'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # Reuse the release notes python-semantic-release generated for us.
+          RELEASE_NOTES: ${{ steps.release.outputs.release_notes }}
+          TAG: ${{ steps.release.outputs.tag }}
+        run: |
+          # Output the release notes to a file
+          printf '%s' "$RELEASE_NOTES" > "$RUNNER_TEMP/release_notes.md"
+          # Creates the release as a draft, uploads the assets, and then
+          # publishes it -- all within this one command.
+          gh release create "$TAG" \
+            --verify-tag \
+            --title "$TAG" \
+            --notes-file "$RUNNER_TEMP/release_notes.md" \
+            dist/*
+
+      - name: Upload | Distribution Artifacts
+        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
+        if: steps.release.outputs.released == 'true'
+        with:
+          name: distribution-artifacts
+          path: dist
+          if-no-files-found: error
+
+    outputs:
+      released: ${{ steps.release.outputs.released || 'false' }}
+      version: ${{ steps.release.outputs.version }}
+
+  publish_to_pypi:
+    # 1. Separate out the publish step from the github release step to run each step at
+    #    the least amount of token privilege
+    # 2. Also, publishing can fail, and its better to have a separate job if you need to retry
+    #    and it won't require reversing the release.
+    runs-on: ubuntu-latest
+    needs: release
+    if: github.ref_name == 'master' && needs.release.outputs.released == 'true'
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Setup | Download Build Artifacts
+        uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        id: artifact-download
+        with:
+          name: distribution-artifacts
+          path: dist
+
+      - name: Publish to PyPi
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

edx_celeryutils-2.1.0/.github/workflows/self-assign-issue.yml

@@ -0,0 +1,12 @@
+# This workflow runs when a comment is made on the ticket
+# If the comment starts with "assign me" it assigns the author to the
+# ticket (case insensitive)
+
+name: Assign comment author to ticket if they say "assign me"
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  self_assign_by_comment:
+    uses: openedx/.github/.github/workflows/self-assign-issue.yml@master

edx_celeryutils-2.1.0/.github/workflows/upgrade-python-requirements.yml

@@ -0,0 +1,22 @@
+name: Upgrade Requirements
+
+on:
+  schedule:
+     - cron: "0 3 * * 4"
+  workflow_dispatch:
+     inputs:
+       branch:
+         description: 'Target branch to create requirements PR against'
+         required: true
+         default: 'master'
+jobs:
+   call-upgrade-python-requirements-workflow:
+    with:
+       branch: ${{ github.event.inputs.branch }}
+       send_success_notification: false
+    secrets:
+       requirements_bot_github_token: ${{ secrets.REQUIREMENTS_BOT_GITHUB_TOKEN }}
+       requirements_bot_github_email: ${{ secrets.REQUIREMENTS_BOT_GITHUB_EMAIL }}
+       edx_smtp_username: ${{ secrets.EDX_SMTP_USERNAME }}
+       edx_smtp_password: ${{ secrets.EDX_SMTP_PASSWORD }}
+    uses: openedx/.github/.github/workflows/upgrade-python-requirements.yml@master

edx_celeryutils-2.1.0/.gitignore

@@ -0,0 +1,74 @@
+*.py[cod]
+__pycache__
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.cache/
+.coverage
+.coverage.*
+.tox
+coverage.xml
+htmlcov/
+
+# Translations
+*.mo
+
+# IDEs and text editors
+*~
+*.swp
+.idea/
+.project
+.pycharm_helpers/
+.pydevproject
+
+# The Silver Searcher
+.agignore
+
+# OS X artifacts
+*.DS_Store
+
+# Logging
+log/
+logs/
+chromedriver.log
+ghostdriver.log
+
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+docs/_build
+docs/modules.rst
+docs/celeryutils.rst
+docs/celeryutils.*.rst
+
+# Private requirements
+requirements/private.in
+requirements/private.txt
+
+# tox environment temporary artifacts
+tests/__init__.py
+
+# Development task artifacts
+default.db

{edx_celeryutils-2.0.0 → edx_celeryutils-2.1.0}/CHANGELOG.rst

@@ -1,6 +1,9 @@
 Change Log
 ----------
 
+This changelog is no longer maintained. Release notes are published only on
+the `GitHub Releases page <https://github.com/openedx/edx-celeryutils/releases>`_.
+
 ..
    All enhancements and patches to edx-celeryutils will be documented
    in this file.  It adheres to the structure of http://keepachangelog.com/ ,

edx_celeryutils-2.1.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include AUTHORS
+include CHANGELOG.rst
+include CONTRIBUTING.rst
+include LICENSE.txt
+include README.rst
+recursive-include src/celery_utils *.html *.png *.gif *js *.css *jpg *jpeg *svg *py

edx_celeryutils-2.1.0/Makefile

@@ -0,0 +1,58 @@
+.PHONY: clean coverage docs help quality requirements test test-all upgrade validate
+
+.DEFAULT_GOAL := help
+
+define BROWSER_PYSCRIPT
+import os, webbrowser, sys
+try:
+	from urllib import pathname2url
+except:
+	from urllib.request import pathname2url
+
+webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
+endef
+export BROWSER_PYSCRIPT
+BROWSER := python -c "$$BROWSER_PYSCRIPT"
+
+help: ## display this help message
+	@echo "Please use \`make <target>' where <target> is one of"
+	@perl -nle'print $& if m{^[a-zA-Z_-]+:.*?## .*$$}' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m  %-25s\033[0m %s\n", $$1, $$2}'
+
+clean: ## remove generated byte code, coverage reports, and build artifacts
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	coverage erase
+	rm -fr build/
+	rm -fr dist/
+	rm -fr *.egg-info
+
+coverage: clean ## generate and view HTML coverage report
+	py.test --cov-report html
+	$(BROWSER) htmlcov/index.html
+
+docs: ## generate Sphinx HTML documentation, including API docs
+	tox -e docs
+	$(BROWSER) docs/_build/html/index.html
+
+upgrade: ## update the uv lockfile with the latest packages satisfying pyproject.toml
+	uv run --with edx-lint edx_lint write_uv_constraints pyproject.toml
+	uv lock --upgrade
+
+quality: ## check coding style with pycodestyle and pylint
+	tox -e quality
+
+requirements: ## install development environment requirements
+	uv sync --group dev
+
+test: clean ## run tests in the current virtualenv
+	py.test tests/ src/celery_utils/
+
+diff_cover: test
+	diff-cover coverage.xml
+
+test-all: ## run tests on every supported Python/Django combination
+	tox -e quality
+	tox
+
+validate: quality test ## run tests and quality checks

edx_celeryutils-2.1.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: edx-celeryutils
+Version: 2.1.0
+Summary: Code to support working with celery
+Author-email: Open edX Project <oscm@openedx.org>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/openedx/edx-celeryutils
+Project-URL: Repository, https://github.com/openedx/edx-celeryutils
+Keywords: Django,edx
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+License-File: AUTHORS
+Requires-Dist: celery<6.0
+Requires-Dist: Django
+Requires-Dist: django-model-utils
+Requires-Dist: jsonfield
+Dynamic: license-file
+
+edx-celeryutils
+=============================
+
+.. image:: https://img.shields.io/pypi/v/edx-celeryutils.svg
+    :target: https://pypi.python.org/pypi/edx-celeryutils/
+    :alt: PyPI
+
+.. image:: https://github.com/openedx/edx-celeryutils/workflows/Python%20CI/badge.svg?branch=master
+    :target: https://github.com/openedx/edx-celeryutils/actions?query=workflow%3A%22Python+CI%22
+    :alt: CI
+
+.. image:: http://codecov.io/github/edx/edx-celeryutils/coverage.svg?branch=master
+    :target: http://codecov.io/github/edx/edx-celeryutils?branch=master
+    :alt: Codecov
+
+.. image:: http://edx-celeryutils.readthedocs.io/en/latest/?badge=latest
+    :target: http://edx-celeryutils.readthedocs.io/en/latest/
+    :alt: Documentation
+
+.. image:: https://img.shields.io/pypi/pyversions/edx-celeryutils.svg
+    :target: https://pypi.python.org/pypi/edx-celeryutils/
+    :alt: Supported Python versions
+
+.. image:: https://img.shields.io/github/license/edx/edx-celeryutils.svg
+    :target: https://github.com/openedx/edx-celeryutils/blob/master/LICENSE.txt
+    :alt: License
+
+Code to support working with Celery, a distributed task queue.
+
+Overview (please modify)
+------------------------
+
+This package contains utilities to wrap tasks with logging and to
+persist them if they fail.
+
+It also supports Django administration for searching and deleting
+failed tasks, and management commands for rerunning failed tasks and
+deleting old ones.
+
+Documentation
+-------------
+
+(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)
+
+Publishing a Release
+--------------------
+
+Merges to master are released automatically by python-semantic-release, which picks the version from the
+conventional commit types. Release notes are on the `GitHub Releases <https://github.com/openedx/edx-celeryutils/releases>`_ page.
+
+License
+-------
+
+The code in this repository is licensed under the Apache 2.0 unless
+otherwise noted.
+
+Please see ``LICENSE.txt`` for details.
+
+How To Contribute
+-----------------
+
+Contributions are very welcome.
+
+Please read `How To Contribute <https://github.com/openedx/.github/blob/master/CONTRIBUTING.md>`_ for details.
+
+Reporting Security Issues
+-------------------------
+
+Please do not report security issues in public. Please email security@openedx.org.
+
+Getting Help
+------------
+
+Have a question about this repository, or about Open edX in general?  Please
+refer to this `list of resources`_ if you need any assistance.
+
+.. _list of resources: https://open.edx.org/getting-help

{edx_celeryutils-2.0.0 → edx_celeryutils-2.1.0}/README.rst

@@ -45,12 +45,8 @@ Documentation
 Publishing a Release
 --------------------
 
-After a PR merges, a new version of the package will automatically be released by Travis when the commit is tagged. Use::
-
-    git tag -a X.Y.Z -m "Releasing version X.Y.Z"
-    git push origin X.Y.Z
-
-Do **not** create a Github Release, or ensure its message points to the CHANGELOG.rst.
+Merges to master are released automatically by python-semantic-release, which picks the version from the
+conventional commit types. Release notes are on the `GitHub Releases <https://github.com/openedx/edx-celeryutils/releases>`_ page.
 
 License
 -------

edx_celeryutils-2.1.0/codecov.yml

@@ -0,0 +1,12 @@
+coverage:
+  status:
+    project:
+      default:
+        enabled: yes
+        target: auto
+    patch:
+      default:
+        enabled: yes
+        target: 100%
+
+comment: false