feat: advertise constraints in setup.py

.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: Python CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches:
+    - '**'
+
+jobs:
+  run_tests:
+    name: Tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-20.04]
+        python-version: ['3.8']
+        toxenv: [django22, django30, django31]
+    steps:
+    - uses: actions/checkout@v1
+    - name: setup python
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install pip
+      run: pip install -r requirements/pip.txt
+
+    - name: Install Dependencies
+      run: pip install -r requirements/ci.txt
+
+    - name: Run Tests
+      env:
+        TOXENV: ${{ matrix.toxenv }}
+      run: tox

.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: edx/.github/.github/workflows/commitlint.yml@master

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

@@ -0,0 +1,68 @@
+name: Upgrade Requirements
+
+on:
+  schedule:
+    # will start the job at 2 every Tuesday (UTC)
+    - cron: "0 2 * * 2"
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: "Target branch to create requirements PR against"
+        required: true
+        default: 'edx_release'
+
+jobs:
+  upgrade_requirements:
+    runs-on: ubuntu-20.04
+
+    strategy:
+      matrix:
+        python-version: ["3.8"]
+
+    steps:
+      - name: setup target branch
+        run: echo "target_branch=$(if ['${{ github.event.inputs.branch }}' = '']; then echo 'edx_release'; else echo '${{ github.event.inputs.branch }}'; fi)" >> $GITHUB_ENV
+
+      - uses: actions/checkout@v1
+        with:
+          ref: ${{ env.target_branch }}
+
+      - name: setup python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: make upgrade
+        run: |
+          cd $GITHUB_WORKSPACE
+          make upgrade
+
+      - name: setup testeng-ci
+        run: |
+          git clone https://github.com/edx/testeng-ci.git
+          cd $GITHUB_WORKSPACE/testeng-ci
+          pip install -r requirements/base.txt
+      - name: create pull request
+        env:
+          GITHUB_TOKEN: ${{ secrets.REQUIREMENTS_BOT_GITHUB_TOKEN }}
+          GITHUB_USER_EMAIL: ${{ secrets.REQUIREMENTS_BOT_GITHUB_EMAIL }}
+        run: |  # replace user-reviewers and team-reviewers accordingly
+          cd $GITHUB_WORKSPACE/testeng-ci
+          python -m jenkins.pull_request_creator --repo-root=$GITHUB_WORKSPACE \
+          --target-branch="${{ env.target_branch }}" --base-branch-name="upgrade-python-requirements" \
+          --commit-message="chore: Updating Python Requirements" --pr-title="Python Requirements Update" \
+          --pr-body="Python requirements update.Please review the [changelogs](https://openedx.atlassian.net/wiki/spaces/TE/pages/1001521320/Python+Package+Changelogs) for the upgraded packages." \
+          --user-reviewers="" --team-reviewers="arbi-bom" --delete-old-pull-requests
+
+      - name: Send failure notification
+        if: ${{ failure() }}
+        uses: dawidd6/action-send-mail@v3
+        with:
+          server_address: email-smtp.us-east-1.amazonaws.com
+          server_port: 465
+          username: ${{secrets.EDX_SMTP_USERNAME}}
+          password: ${{secrets.EDX_SMTP_PASSWORD}}
+          subject: Upgrade python requirements workflow failed in ${{github.repository}}
+          to: [email protected]  # replace the email with team's email address
+          from: github-actions <[email protected]>
+          body: Upgrade python requirements workflow in ${{github.repository}} failed! For details see "github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"

.gitignore

@@ -31,3 +31,5 @@ virtualenv
 # text editors
 *~
 *.swp
+
+.idea/

.travis.yml

@@ -0,0 +1,11 @@
+language: python
+python:
+  - 3.8
+install:
+  - pip install -r requirements/ci.txt
+env:
+  - TOXENV=py38-django22
+  - TOXENV=py38-django30
+  - TOXENV=py38-django31
+script:
+  - tox

MANIFEST.in

@@ -0,0 +1,9 @@
+include CHANGELOG.rst
+include CONTRIBUTING.rst
+include LICENSE.txt
+include README.rst
+recursive-include wiki *.html *.png *.gif *js *.css *jpg *jpeg *svg *py *.txt *.json
+recursive-include django_notify *.html *.png *.gif *js *.css *jpg *jpeg *svg *py *.txt *.json
+include requirements/base.in
+
+include requirements/constraints.txt

Makefile

@@ -0,0 +1,14 @@
+upgrade: export CUSTOM_COMPILE_COMMAND=make upgrade
+upgrade:
+	pip install -q -r requirements/pip_tools.txt
+	pip-compile --upgrade --allow-unsafe --rebuild -o requirements/pip.txt requirements/pip.in
+	pip-compile --upgrade -o requirements/pip_tools.txt requirements/pip_tools.in
+	pip-compile --upgrade -o requirements/base.txt requirements/base.in
+	pip-compile --upgrade -o requirements/docs.txt requirements/docs.in
+	pip-compile --upgrade -o requirements/test.txt requirements/test.in
+	pip-compile --upgrade -o requirements/tox.txt requirements/tox.in
+	pip-compile --upgrade -o requirements/ci.txt requirements/ci.in
+	# Let tox control the Django version for tests
+	grep -e "^django==" requirements/base.txt > requirements/django.txt
+	sed '/^[dD]jango==/d' requirements/test.txt > requirements/test.tmp
+	mv requirements/test.tmp requirements/test.txt

django_notify/__init__.py

@@ -1,40 +0,0 @@
-from django.contrib.contenttypes.models import ContentType
-from django.db.models import Model
-from django.utils.translation import ugettext as _
-
-import models
-
-_disable_notifications = False
-
-def notify(message, key, target_object=None, url=None):
-    """
-    Notify subscribing users of a new event. Key can be any kind of string,
-    just make sure to reuse it where applicable! Object_id is some identifier
-    of an object, for instance if a user subscribes to a specific comment thread,
-    you could write:
-
-    notify("there was a response to your comment", "comment_response", 
-           target_object=PostersObject, 
-           url=reverse('comments:view', args=(PostersObject.id,)))
-
-    The below example notifies everyone subscribing to the "new_comments" key
-    with the message "New comment posted".
-
-    notify("New comment posted", "new_comments")
-
-    """
-
-    if _disable_notifications:
-        return 0
-
-    if target_object:
-        if not isinstance(target_object, Model):
-            raise TypeError(_(u"You supplied a target_object that's not an instance of a django Model."))
-        object_id = target_object.id
-    else:
-        object_id = None
-
-    objects = models.Notification.create_notifications(key, object_id=object_id, 
-                                                       message=message, url=url)
-    return len(objects)
-

django_notify/admin.py

@@ -5,4 +5,4 @@
 admin.site.register(models.NotificationType)
 admin.site.register(models.Notification)
 admin.site.register(models.Settings)
-admin.site.register(models.Subscription)
+admin.site.register(models.Subscription)

django_notify/decorators.py

@@ -1,10 +1,11 @@
-# -*- coding: utf-8 -*-
-from django.utils import simplejson as json
-from django.http import HttpResponse
+import json
+
 from django.contrib.auth.decorators import login_required
+from django.http import HttpResponse
 
 import django_notify
 
+
 def disable_notify(func):
     """Disable notifications. Example:
 
@@ -25,7 +26,7 @@ def login_required_ajax(func):
 
     def wrap(request, *args, **kwargs):
         if request.is_ajax():
-            if not request.user or not request.user.is_authenticated():
+            if not request.user or not request.user.is_authenticated:
                 return json_view(lambda *a, **kw: {'error': 'not logged in'})(request, status=403)
             return func(request, *args, **kwargs)
         else:
@@ -37,8 +38,7 @@ def wrap(request, *args, **kwargs):
         obj = func(request, *args, **kwargs)
         data = json.dumps(obj, ensure_ascii=False)
         status = kwargs.get('status', 200)
-        response = HttpResponse(mimetype='application/json', status=status)
+        response = HttpResponse(content_type='application/json', status=status)
         response.write(data)
         return response
     return wrap
-