diff --git a/.annotation_safe_list.yml b/.annotation_safe_list.yml new file mode 100644 index 0000000..45c6a18 --- /dev/null +++ b/.annotation_safe_list.yml @@ -0,0 +1,37 @@ +# This is a Code Annotations automatically-generated Django model safelist file. +# These models must be annotated as follows in order to be counted in the coverage report. +# See https://code-annotations.readthedocs.io/en/latest/safelist.html for more information. +# +# fake_app_1.FakeModelName: +# ".. no_pii:": "This model has no PII" +# fake_app_2.FakeModel2: +# ".. choice_annotation:": foo, bar, baz + +admin.LogEntry: + ".. no_pii:": "This model has no PII" +auth.Group: + ".. no_pii:": "This model has no PII" +auth.Permission: + ".. no_pii:": "This model has no PII" +contenttypes.ContentType: + ".. no_pii:": "This model has no PII" +sessions.Session: + ".. no_pii:": "This model has no PII" +social_django.Association: + ".. no_pii:": "This model has no PII" +social_django.Code: + ".. pii:": "Email address" + ".. pii_types:": other + ".. pii_retirement:": local_api +social_django.Nonce: + ".. no_pii:": "This model has no PII" +social_django.Partial: + ".. no_pii:": "This model has no PII" +social_django.UserSocialAuth: + ".. no_pii:": "This model has no PII" +waffle.Flag: + ".. no_pii:": "This model has no PII" +waffle.Sample: + ".. no_pii:": "This model has no PII" +waffle.Switch: + ".. no_pii:": "This model has no PII" diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..d247318 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,12 @@ +[run] +branch = True +data_file = .coverage +source=flashcards +omit = + flashcards/settings/* + flashcards/conf/* + *wsgi.py + */migrations/* + *admin.py + */static/* + */templates/* diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..5cf5aed --- /dev/null +++ b/.editorconfig @@ -0,0 +1,100 @@ +# *************************** +# ** DO NOT EDIT THIS FILE ** +# *************************** +# +# This file was generated by edx-lint: https://github.com/openedx/edx-lint +# +# If you want to change this file, you have two choices, depending on whether +# you want to make a local change that applies only to this repo, or whether +# you want to make a central change that applies to all repos using edx-lint. +# +# Note: If your .editorconfig file is simply out-of-date relative to the latest +# .editorconfig in edx-lint, ensure you have the latest edx-lint installed +# and then follow the steps for a "LOCAL CHANGE". +# +# LOCAL CHANGE: +# +# 1. Edit the local .editorconfig_tweaks file to add changes just to this +# repo's file. +# +# 2. Run: +# +# $ edx_lint write .editorconfig +# +# 3. This will modify the local file. Submit a pull request to get it +# checked in so that others will benefit. +# +# +# CENTRAL CHANGE: +# +# 1. Edit the .editorconfig file in the edx-lint repo at +# https://github.com/openedx/edx-lint/blob/master/edx_lint/files/.editorconfig +# +# 2. install the updated version of edx-lint (in edx-lint): +# +# $ pip install . +# +# 3. Run (in edx-lint): +# +# $ edx_lint write .editorconfig +# +# 4. Make a new version of edx_lint, submit and review a pull request with the +# .editorconfig update, and after merging, update the edx-lint version and +# publish the new version. +# +# 5. In your local repo, install the newer version of edx-lint. +# +# 6. Run: +# +# $ edx_lint write .editorconfig +# +# 7. This will modify the local file. Submit a pull request to get it +# checked in so that others will benefit. +# +# +# +# +# +# STAY AWAY FROM THIS FILE! +# +# +# +# +# +# SERIOUSLY. +# +# ------------------------------ +# Generated by edx-lint version: 5.2.5 +# ------------------------------ +[*] +end_of_line = lf +insert_final_newline = true +charset = utf-8 +indent_style = space +indent_size = 4 +max_line_length = 120 +trim_trailing_whitespace = true + +[{Makefile, *.mk}] +indent_style = tab +indent_size = 8 + +[*.{yml,yaml,json}] +indent_size = 2 + +[*.js] +indent_size = 2 + +[*.diff] +trim_trailing_whitespace = false + +[.git/*] +trim_trailing_whitespace = false + +[COMMIT_EDITMSG] +max_line_length = 72 + +[*.rst] +max_line_length = 79 + +# f2f02689fced7a2e0c62c2f9803184114dc2ae4b diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ac656cb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ + +**Merge checklist:** +Check off if complete *or* not applicable: +- [ ] Documentation updated (not only docstrings) +- [ ] Fixup commits are squashed away +- [ ] Unit tests added/updated +- [ ] Manual testing instructions provided +- [ ] Noted any: Concerns, dependencies, migration issues, deadlines, tickets + +**Post-merge:** +- [ ] [Backported](https://openedx.atlassian.net/wiki/spaces/COMM/pages/2065367719/Making+a+pull+request+for+a+named+release) to latest and next named releases diff --git a/.github/workflows/check-reserved-keywords.yml b/.github/workflows/check-reserved-keywords.yml new file mode 100644 index 0000000..8e9c60f --- /dev/null +++ b/.github/workflows/check-reserved-keywords.yml @@ -0,0 +1,27 @@ +name: Check Reserved Keywords + +on: + - pull_request + +jobs: + check-reserved-keywords: + name: Check Reserved Keywords + runs-on: ubuntu-20.04 + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: setup python + uses: actions/setup-python@v2 + with: + python-version: 3.9 + + - name: Install pip + run: pip install -r requirements/pip.txt + + - name: Install Dependencies + run: pip install -r requirements/dev.txt + + - name: Check Keywords + run: make check_keywords diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..e0e218a --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,44 @@ +name: Python CI + +on: + push: + branches: [ main ] + pull_request: + branches: + - '**' + + +jobs: + run_tests: + name: tests + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: [ubuntu-20.04] + python-version: ['3.9'] + toxenv: ["py39", "quality", "docs", "pii_check"] + + steps: + - uses: actions/checkout@v3 + - 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 + + - name: Run coverage + if: matrix.python-version == '3.9' && matrix.toxenv == 'py39' + uses: codecov/codecov-action@v3 + with: + flags: unittests + fail_ci_if_error: true diff --git a/.github/workflows/commitlint.yml b/.github/workflows/commitlint.yml new file mode 100644 index 0000000..fec11d6 --- /dev/null +++ b/.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 diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml new file mode 100644 index 0000000..0452cf2 --- /dev/null +++ b/.github/workflows/docker-publish.yml @@ -0,0 +1,22 @@ +name: Push Docker Images + +on: + push: + branches: + - main +jobs: + # Push image to GitHub Packages. + # See also https://docs.docker.com/docker-hub/builds/ + push: + runs-on: ubuntu-latest + if: github.event_name == 'push' + + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Build and Push docker image + env: + DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }} + DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }} + run : make github_docker_push diff --git a/.github/workflows/upgrade-python-requirements.yml b/.github/workflows/upgrade-python-requirements.yml new file mode 100644 index 0000000..1617a9b --- /dev/null +++ b/.github/workflows/upgrade-python-requirements.yml @@ -0,0 +1,28 @@ +name: Upgrade Python Requirements + +on: + schedule: + - cron: "0 0 * * 1" + workflow_dispatch: + inputs: + branch: + description: "Target branch against which to create requirements PR" + required: true + default: 'main' + +jobs: + call-upgrade-python-requirements-workflow: + uses: openedx/.github/.github/workflows/upgrade-python-requirements.yml@master + with: + branch: ${{ github.event.inputs.branch || 'main' }} + python_version: "3.9" + # optional parameters below; fill in if you'd like github or email notifications + user_reviewers: "jmbowman" + # team_reviewers: "" + # email_address: "" + # 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 }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..51d7c4a --- /dev/null +++ b/.gitignore @@ -0,0 +1,95 @@ +*.py[cod] + +*.log + +# C extensions +*.so + +# Packages +*.egg +*.egg-info +dist +build +eggs +parts +bin +var +sdist +develop-eggs +.installed.cfg +lib +lib64 +__pycache__ + +# Installer logs +pip-log.txt + +# Django +default.db + +# Static assets +media/cache/ +assets/ + +# Unit test / coverage reports +.coverage +htmlcov +.tox +nosetests.xml +unittests.xml + +# PII annotation reports +pii_report + +### Internationalization artifacts +*.mo +*.po +*.prob +!django.po +!django.mo +!djangojs.po +!djangojs.mo +flashcards/conf/locale/fake*/LC_MESSAGES/*.po +flashcards/conf/locale/fake*/LC_MESSAGES/*.mo +flashcards/conf/locale/messages.mo + + +# Mr Developer +.mr.developer.cfg +.project +.pydevproject + +# QA +coverage.xml +diff_*.html +*.report +report +venv +acceptance_tests.*.log +acceptance_tests.*.png + +# Override config files +override.cfg +private.py + +# JetBrains +.idea + +# Visual Studio Code +.vscode + +# Emacs +*~ + +# OS X +.DS_Store + +# Editor Temp Files +*.swp + +*.trace + +docs/_build/ + +#transifex exe +tx diff --git a/.pii_annotations.yml b/.pii_annotations.yml new file mode 100644 index 0000000..7da8f3c --- /dev/null +++ b/.pii_annotations.yml @@ -0,0 +1,35 @@ +source_path: ./ +report_path: pii_report +safelist_path: .annotation_safe_list.yml +coverage_target: 100.0 +annotations: + ".. no_pii:": + "pii_group": + - ".. pii:": + - ".. pii_types:": + choices: + - id # Unique identifier for the user which is shared across systems + - name # Used for any part of the user's name + - username + - password + - location # Used for any part of any type address or country stored + - phone_number # Used for phone or fax numbers + - email_address + - birth_date # Used for any part of a stored birth date + - ip # IP address + - external_service # Used for external service ids or links such as social media links or usernames, website links, etc. + - biography # Any type of free-form biography field + - gender + - sex + - image + - video + - other + - ".. pii_retirement:": + choices: + - retained # Intentionally kept for legal reasons + - local_api # An API exists in this repository for retiring this information + - consumer_api # The data's consumer must implement an API for retiring this information + - third_party # A third party API exists to retire this data +extensions: + python: + - py diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..8e9a19d --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,15 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +python: + version: 3.9 + install: + - requirements: requirements/doc.txt diff --git a/.tx/config b/.tx/config new file mode 100644 index 0000000..c08ca9d --- /dev/null +++ b/.tx/config @@ -0,0 +1,14 @@ +[main] +host = https://www.transifex.com + +[o:open-edx:p:edx-platform:r:flashcards] +file_filter = flashcards/conf/locale//LC_MESSAGES/django.po +source_file = flashcards/conf/locale/en/LC_MESSAGES/django.po +source_lang = en +type = PO + +[o:open-edx:p:edx-platform:r:flashcards-js] +file_filter = flashcards/conf/locale//LC_MESSAGES/djangojs.po +source_file = flashcards/conf/locale/en/LC_MESSAGES/djangojs.po +source_lang = en +type = PO diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..e3a2804 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,67 @@ +FROM ubuntu:focal as app +MAINTAINER sre@edx.org + + +# Packages installed: + +# language-pack-en locales; ubuntu locale support so that system utilities have a consistent +# language and time zone. + +# python; ubuntu doesnt ship with python, so this is the python we will use to run the application + +# python3-pip; install pip to install application requirements.txt files + +# libmysqlclient-dev; to install header files needed to use native C implementation for +# MySQL-python for performance gains. + +# libssl-dev; # mysqlclient wont install without this. + +# python3-dev; to install header files for python extensions; much wheel-building depends on this + +# gcc; for compiling python extensions distributed with python packages like mysql-client + +# If you add a package here please include a comment above describing what it is used for +RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get -qy install --no-install-recommends \ + language-pack-en locales \ + python3.8 python3-dev python3-pip \ + # The mysqlclient Python package has install-time dependencies + libmysqlclient-dev libssl-dev pkg-config \ + gcc + + +RUN pip install --upgrade pip setuptools +# delete apt package lists because we do not need them inflating our image +RUN rm -rf /var/lib/apt/lists/* + +RUN ln -s /usr/bin/python3 /usr/bin/python + +RUN locale-gen en_US.UTF-8 +ENV LANG en_US.UTF-8 +ENV LANGUAGE en_US:en +ENV LC_ALL en_US.UTF-8 +ENV DJANGO_SETTINGS_MODULE flashcards.settings.production + +EXPOSE 8491 +RUN useradd -m --shell /bin/false app + +WORKDIR /edx/app/flashcards + +# Copy the requirements explicitly even though we copy everything below +# this prevents the image cache from busting unless the dependencies have changed. +COPY requirements/production.txt /edx/app/flashcards/requirements/production.txt + +# Dependencies are installed as root so they cannot be modified by the application user. +RUN pip install -r requirements/production.txt + +RUN mkdir -p /edx/var/log + +# Code is owned by root so it cannot be modified by the application user. +# So we copy it before changing users. +USER app + +# Gunicorn 19 does not log to stdout or stderr by default. Once we are past gunicorn 19, the logging to STDOUT need not be specified. +CMD gunicorn --workers=2 --name flashcards -c /edx/app/flashcards/flashcards/docker_gunicorn_configuration.py --log-file - --max-requests=1000 flashcards.wsgi:application + +# This line is after the requirements so that changes to the code will not +# bust the image cache +COPY . /edx/app/flashcards diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..8a87330 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,664 @@ + + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. + + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..fc3d1a5 --- /dev/null +++ b/Makefile @@ -0,0 +1,205 @@ +.DEFAULT_GOAL := help + +.PHONY: help clean clean_tox docs requirements ci_requirements dev_requirements \ + validation_requirements doc_requirements production-requirements static shell \ + test coverage isort_check isort style lint quality pii_check validate \ + migrate html_coverage upgrade extract_translation dummy_translations \ + compile_translations fake_translations pull_translations \ + push_translations start-devstack open-devstack pkg-devstack \ + detect_changed_source_translations validate_translations check_keywords \ + install_transifex_client + +# For opening files in a browser. Use like: $(BROWSER)relative/path/to/file.html +BROWSER := python -m webbrowser file://$(CURDIR)/ + +# Generates a help message. Borrowed from https://github.com/pydanny/cookiecutter-djangopackage. +help: ## display this help message + @echo "Please use \`make \` where is one of" + @awk -F ':.*?## ' '/^[a-zA-Z]/ && NF==2 {printf "\033[36m %-25s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort + +clean: ## delete generated byte code and coverage reports + find . -name '*.pyc' -delete + coverage erase + rm -rf assets + rm -rf pii_report + +clean_tox: ## clear tox requirements cache + rm -fr .tox + +docs: ## generate Sphinx HTML documentation, including API docs + tox -e docs + $(BROWSER)docs/_build/html/index.html + +piptools: ## install pinned version of pip-compile and pip-sync + pip install -r requirements/pip.txt + pip install -r requirements/pip-tools.txt + +requirements: dev_requirements ## sync to default requirements + +ci_requirements: validation_requirements ## sync to requirements needed for CI checks + +dev_requirements: clean_tox piptools ## sync to requirements for local development + pip-sync -q requirements/dev.txt requirements/private.* + +validation_requirements: piptools ## sync to requirements for testing & code quality checking + pip-sync -q requirements/validation.txt + +doc_requirements: piptools + pip-sync -q requirements/doc.txt + +production-requirements: piptools ## install requirements for production + pip-sync -q requirements/production.txt + +static: ## generate static files + python manage.py collectstatic --noinput + +shell: ## run Django shell + python manage.py shell + +test: clean ## run tests and generate coverage report + pytest + +# To be run from CI context +coverage: clean + pytest --cov-report html + $(BROWSER)htmlcov/index.html + +isort_check: ## check that isort has been run + isort --check-only flashcards/ + +isort: ## run isort to sort imports in all Python files + isort --atomic flashcards/ + +style: ## run Python style checker + pylint --rcfile=pylintrc flashcards *.py + +lint: ## run Python code linting + pylint --rcfile=pylintrc flashcards *.py + +quality: + tox -e quality + +pii_check: ## check for PII annotations on all Django models + DJANGO_SETTINGS_MODULE=flashcards.settings.test \ + code_annotations django_find_annotations --config_file .pii_annotations.yml --lint --report --coverage + +check_keywords: ## Scan the Django models in all installed apps in this project for restricted field names + python manage.py check_reserved_keywords --override_file db_keyword_overrides.yml + +validate: test quality pii_check check_keywords ## run tests, quality, and PII annotation checks + +migrate: ## apply database migrations + python manage.py migrate + +html_coverage: ## generate and view HTML coverage report + coverage html && open htmlcov/index.html + +# Define PIP_COMPILE_OPTS=-v to get more information during make upgrade. +PIP_COMPILE = pip-compile --upgrade $(PIP_COMPILE_OPTS) + +upgrade: export CUSTOM_COMPILE_COMMAND=make upgrade +upgrade: ## update the requirements/*.txt files with the latest packages satisfying requirements/*.in + pip install -qr requirements/pip-tools.txt + # Make sure to compile files after any other files they include! + $(PIP_COMPILE) --allow-unsafe -o requirements/pip.txt requirements/pip.in + $(PIP_COMPILE) -o requirements/pip-tools.txt requirements/pip-tools.in + pip install -qr requirements/pip.txt + pip install -qr requirements/pip-tools.txt + $(PIP_COMPILE) -o requirements/base.txt requirements/base.in + $(PIP_COMPILE) -o requirements/test.txt requirements/test.in + $(PIP_COMPILE) -o requirements/doc.txt requirements/doc.in + $(PIP_COMPILE) -o requirements/quality.txt requirements/quality.in + $(PIP_COMPILE) -o requirements/validation.txt requirements/validation.in + $(PIP_COMPILE) -o requirements/ci.txt requirements/ci.in + $(PIP_COMPILE) -o requirements/dev.txt requirements/dev.in + $(PIP_COMPILE) -o requirements/production.txt requirements/production.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 + +extract_translations: ## extract strings to be translated, outputting .mo files + python manage.py makemessages -l en -v1 -d django + python manage.py makemessages -l en -v1 -d djangojs + +dummy_translations: ## generate dummy translation (.po) files + cd flashcards && i18n_tool dummy + +compile_translations: # compile translation files, outputting .po files for each supported language + python manage.py compilemessages + +fake_translations: extract_translations dummy_translations compile_translations ## generate and compile dummy translation files + +pull_translations: ## pull translations from Transifex + tx pull -af -t --mode reviewed + +push_translations: ## push source translation files (.po) from Transifex + tx push -s + +start-devstack: ## run a local development copy of the server + docker-compose --x-networking up + +open-devstack: ## open a shell on the server started by start-devstack + docker exec -it flashcards /edx/app/flashcards/devstack.sh open + +pkg-devstack: ## build the flashcards image from the latest configuration and code + docker build -t flashcards:latest -f docker/build/flashcards/Dockerfile git://github.com/openedx/configuration + +detect_changed_source_translations: ## check if translation files are up-to-date + cd flashcards && i18n_tool changed + +validate_translations: fake_translations detect_changed_source_translations ## install fake translations and check if translation files are up-to-date + +docker_build: + docker build . -f Dockerfile -t openedx/flashcards + +# devstack-themed shortcuts +dev.up: # Starts all containers + docker-compose up -d + +dev.up.build: + docker-compose up -d --build + +dev.down: # Kills containers and all of their data that isn't in volumes + docker-compose down + +dev.stop: # Stops containers so they can be restarted + docker-compose stop + +app-shell: # Run the app shell as root + docker exec -u 0 -it flashcards.app bash + +db-shell: # Run the app shell as root, enter the app's database + docker exec -u 0 -it flashcards.db mysql -u root flashcards + +%-logs: # View the logs of the specified service container + docker-compose logs -f --tail=500 $* + +%-restart: # Restart the specified service container + docker-compose restart $* + +%-attach: + docker attach flashcards.$* + +github_docker_build: + docker build . -f Dockerfile --target app -t openedx/flashcards + +github_docker_tag: github_docker_build + docker tag openedx/flashcards openedx/flashcards:${GITHUB_SHA} + +github_docker_auth: + echo "$$DOCKERHUB_PASSWORD" | docker login -u "$$DOCKERHUB_USERNAME" --password-stdin + +github_docker_push: github_docker_tag github_docker_auth ## push to docker hub + docker push 'openedx/flashcards:latest' + docker push "openedx/flashcards:${GITHUB_SHA}" + +selfcheck: ## check that the Makefile is well-formed + @echo "The Makefile is well-formed." + +install_transifex_client: ## Install the Transifex client + # Instaling client will skip CHANGELOG and LICENSE files from git changes + # so remind the user to commit the change first before installing client. + git diff -s --exit-code HEAD || { echo "Please commit changes first."; exit 1; } + curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash + git checkout -- LICENSE README.md ## overwritten by Transifex installer diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..98eb9f3 --- /dev/null +++ b/README.rst @@ -0,0 +1,198 @@ +flashcards +############################# + +.. note:: + + This README was auto-generated. Maintainer: please review its contents and + update all relevant sections. Instructions to you are marked with + "PLACEHOLDER" or "TODO". Update or remove those sections, and remove this + note when you are done. + +|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge| +|license-badge| |status-badge| + +Purpose +******* + +Service for managing and displaying flashcards + +This service contains the following functionality: + +* Generate flashcard candidates from course content via OpenAI +* Display flashcards to learners + +Future versions will also include interfaces for selecting which generated +cards to actually use and authoring new cards. + +The service leverages the Anki project for flashcard management and display. + + +Getting Started +*************** + +Developing +========== + +One Time Setup +-------------- +.. code-block:: + + # Clone the repository + git clone git@github.com:edx/flashcards.git + cd flashcards + + # Set up a virtualenv with the same name as the repo and activate it + # Here's how you might do that if you have virtualenvwrapper setup. + mkvirtualenv -p python3.8 flashcards + + +Every time you develop something in this repo +--------------------------------------------- +.. code-block:: + + # Activate the virtualenv + # Here's how you might do that if you're using virtualenvwrapper. + workon flashcards + + # Grab the latest code + git checkout main + git pull + + # Install/update the dev requirements + make requirements + + # Run the tests and quality checks (to verify the status before you make any changes) + make validate + + # Make a new branch for your changes + git checkout -b / + + # Using your favorite editor, edit the code to make your change. + vim ... + + # Run your new tests + pytest ./path/to/new/tests + + # Run all the tests and quality checks + make validate + + # Commit all your changes + git commit ... + git push + + # Open a PR and ask for review. + +Deploying +========= + +TODO: How can a new user go about deploying this component? Is it just a few +commands? Is there a larger how-to that should be linked here? + +PLACEHOLDER: For details on how to deploy this component, see the `deployment how-to`_ + +.. _deployment how-to: https://docs.openedx.org/projects/flashcards/how-tos/how-to-deploy-this-component.html + +Getting Help +************ + +Documentation +============= + +PLACEHOLDER: Start by going through `the documentation`_. If you need more help see below. + +.. _the documentation: https://docs.openedx.org/projects/flashcards + +(TODO: `Set up documentation `_) + +More Help +========= + +If you're having trouble, we have discussion forums at +https://discuss.openedx.org where you can connect with others in the +community. + +Our real-time conversations are on Slack. You can request a `Slack +invitation`_, then join our `community Slack workspace`_. + +For anything non-trivial, the best path is to open an issue in this +repository with as many details about the issue you are facing as you +can provide. + +https://github.com/edx/flashcards/issues + +For more information about these options, see the `Getting Help `__ page. + +.. _Slack invitation: https://openedx.org/slack +.. _community Slack workspace: https://openedx.slack.com/ + +License +******* + +The code in this repository is licensed under the AGPL 3.0 unless +otherwise noted. + +Please see `LICENSE.txt `_ for details. + +Contributing +************ + +Contributions are very welcome. +Please read `How To Contribute `_ for details. + +This project is currently accepting all types of contributions, bug fixes, +security fixes, maintenance work, or new features. However, please make sure +to have a discussion about your new feature idea with the maintainers prior to +beginning development to maximize the chances of your change being accepted. +You can start a conversation by creating a new issue on this repo summarizing +your idea. + +The Open edX Code of Conduct +**************************** + +All community members are expected to follow the `Open edX Code of Conduct`_. + +.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/ + +People +****** + +The assigned maintainers for this component and other project details may be +found in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml`` +file in this repo. + +.. _Backstage: https://backstage.openedx.org/catalog/default/component/flashcards + +Reporting Security Issues +************************* + +Please do not report security issues in public. Please email security@openedx.org. + +.. |pypi-badge| image:: https://img.shields.io/pypi/v/flashcards.svg + :target: https://pypi.python.org/pypi/flashcards/ + :alt: PyPI + +.. |ci-badge| image:: https://github.com/edx/flashcards/workflows/Python%20CI/badge.svg?branch=main + :target: https://github.com/edx/flashcards/actions + :alt: CI + +.. |codecov-badge| image:: https://codecov.io/github/edx/flashcards/coverage.svg?branch=main + :target: https://codecov.io/github/edx/flashcards?branch=main + :alt: Codecov + +.. |doc-badge| image:: https://readthedocs.org/projects/flashcards/badge/?version=latest + :target: https://docs.openedx.org/projects/flashcards + :alt: Documentation + +.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/flashcards.svg + :target: https://pypi.python.org/pypi/flashcards/ + :alt: Supported Python versions + +.. |license-badge| image:: https://img.shields.io/github/license/edx/flashcards.svg + :target: https://github.com/edx/flashcards/blob/main/LICENSE.txt + :alt: License + +.. TODO: Choose one of the statuses below and remove the other status-badge lines. +.. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow +.. .. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen +.. .. |status-badge| image:: https://img.shields.io/badge/Status-Deprecated-orange +.. .. |status-badge| image:: https://img.shields.io/badge/Status-Unsupported-red diff --git a/catalog-info.yaml b/catalog-info.yaml new file mode 100644 index 0000000..3ad2523 --- /dev/null +++ b/catalog-info.yaml @@ -0,0 +1,32 @@ +# This file records information about this repo. Its use is described in OEP-55: +# https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html + +apiVersion: backstage.io/v1alpha1 +kind: "" +metadata: + name: 'flashcards' + description: "Service for managing and displaying flashcards" + annotations: + # (Optional) Annotation keys and values can be whatever you want. + # We use it in Open edX repos to have a comma-separated list of GitHub user + # names that might be interested in changes to the architecture of this + # component. + openedx.org/arch-interest-groups: "jmbowman" +spec: + + # (Required) This can be a group(`group:` or a user(`user:`) + owner: "user:jmbowman" + + # (Required) Acceptable Type Values: service, website, library + type: 'service' + + # (Required) Acceptable Lifecycle Values: experimental, production, deprecated + lifecycle: 'experimental' + + # (Optional) The value can be the name of any known component. + # subcomponentOf: '' + + # (Optional) An array of different components or resources. + # dependsOn: + # - '' + # - '' diff --git a/codecov.yml b/codecov.yml new file mode 100644 index 0000000..4da4768 --- /dev/null +++ b/codecov.yml @@ -0,0 +1,12 @@ +coverage: + status: + project: + default: + enabled: yes + target: auto + patch: + default: + enabled: yes + target: 100% + +comment: false diff --git a/db_keyword_overrides.yml b/db_keyword_overrides.yml new file mode 100644 index 0000000..62a4d61 --- /dev/null +++ b/db_keyword_overrides.yml @@ -0,0 +1,13 @@ +# This file is used by the 'check_reserved_keywords' management command to allow specific field names to be overridden +# when checking for conflicts with lists of restricted keywords used in various database/data warehouse tools. +# For more information, see: +# https://openedx.atlassian.net/wiki/spaces/DE/pages/1411809288/Reserved+Keyword+Linter +# and +# https://github.com/openedx/edx-django-release-util/release_util/management/commands/check_reserved_keywords.py +# +# overrides should be added in the following format: +# - ModelName.field_name +--- +MYSQL: +SNOWFLAKE: +STITCH: diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..dd78c28 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,41 @@ +version: "2.1" +services: + db: + image: mysql:8.0 + container_name: flashcards.db + environment: + # See how these environment variables being used at https://github.com/mysql/mysql-docker/blob/mysql-server/8.0/docker-entrypoint.sh + MYSQL_ROOT_PASSWORD: "" + MYSQL_ALLOW_EMPTY_PASSWORD: "yes" + networks: + - devstack_default + volumes: + - flashcards_mysql:/var/lib/mysql + + memcache: + image: memcached:1.4.24 + container_name: flashcards.memcache + + app: + # Uncomment this line to use the official flashcards base image + image: openedx/flashcards + + container_name: flashcards.app + volumes: + - .:/edx/app/flashcards/ + command: bash -c 'while true; do python /edx/app/flashcards/manage.py runserver 0.0.0.0:8491; sleep 2; done' + environment: + DJANGO_SETTINGS_MODULE: flashcards.settings.devstack + ports: + - "8491:8491" # TODO: change this to your port + networks: + - devstack_default + stdin_open: true + tty: true + +networks: + devstack_default: + external: true + +volumes: + flashcards_mysql: diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..49b4d89 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,230 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from https://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " epub3 to make an epub3" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + @echo " dummy to check syntax errors of document sources" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +.PHONY: qthelp +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/flashcards.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/flashcards.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/flashcards" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/flashcards" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: epub3 +epub3: + $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 + @echo + @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." + +.PHONY: latex +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +.PHONY: info +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +.PHONY: dummy +dummy: + $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy + @echo + @echo "Build finished. Dummy builder generates no files." diff --git a/docs/__init__.py b/docs/__init__.py new file mode 100644 index 0000000..ff3741f --- /dev/null +++ b/docs/__init__.py @@ -0,0 +1 @@ +# Included so Django's startproject command runs against the docs directory. diff --git a/docs/_static/theme_overrides.css b/docs/_static/theme_overrides.css new file mode 100644 index 0000000..aad8245 --- /dev/null +++ b/docs/_static/theme_overrides.css @@ -0,0 +1,10 @@ +/* override table width restrictions */ +.wy-table-responsive table td, .wy-table-responsive table th { + /* !important prevents the common CSS stylesheets from + overriding this as on RTD they are loaded after this stylesheet */ + white-space: normal !important; +} + +.wy-table-responsive { + overflow: visible !important; +} diff --git a/docs/concepts/index.rst b/docs/concepts/index.rst new file mode 100644 index 0000000..8a2b4bd --- /dev/null +++ b/docs/concepts/index.rst @@ -0,0 +1,2 @@ +Concepts +######## diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..026cc5f --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,540 @@ +# pylint: disable=invalid-name +""" +flashcards documentation build configuration file. + +This file is execfile()d with the current directory set to its +containing dir. + +Note that not all possible configuration values are present in this +autogenerated file. + +All configuration values have a default; values that are commented out +serve to show the default. +""" +import os +import re +import sys +from datetime import datetime +from subprocess import check_call + + +def get_version(*file_paths): + """ + Extract the version string from the file. + + Input: + - file_paths: relative path fragments to file with + version string + """ + filename = os.path.join(os.path.dirname(__file__), *file_paths) + version_file = open(filename, encoding="utf8").read() + version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", version_file, re.M) + if version_match: + return version_match.group(1) + raise RuntimeError('Unable to find version string.') + + +REPO_ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) +sys.path.append(REPO_ROOT) + +VERSION = get_version('../flashcards', '__init__.py') + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.ifconfig', + 'sphinx.ext.napoleon' +] + +# A list of warning types to suppress arbitrary warning messages. +suppress_warnings = [ + 'image.nonlocal_uri', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +# +# source_encoding = 'utf-8-sig' + +# The top level toctree document. +top_level_doc = 'index' + +# General information about the project. +project = 'flashcards' +copyright = f'{datetime.now().year}, Axim Collaborative, Inc.' # pylint: disable=redefined-builtin +author = 'Axim Collaborative, Inc.' +project_title = 'flashcards' +documentation_title = f"{project_title}" + +# Set display_github to False if you don't want "edit on Github" button +html_context = { + "display_github": True, # Integrate GitHub + "github_user": "edx", # Username + "github_repo": 'flashcards', # Repo name + "github_version": "main", # Version + "conf_py_path": "/docs/", # Path in the checkout to the docs root +} + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = VERSION +# The full version, including alpha/beta/rc tags. +release = VERSION + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'en' + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# +# today = '' +# +# Else, today_fmt is used as the format for a strftime call. +# +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [ + '_build', + 'Thumbs.db', + '.DS_Store', + # This file is intended as a guide for developers browsing the source tree, + # not to be rendered into the output docs. + 'decisions/README.rst', +] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. + +html_theme = 'sphinx_book_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = { + "repository_url": "https://github.com/edx/flashcards", + "repository_branch": 'main', + "path_to_docs": "docs/", + "home_page_in_toc": True, + "use_repository_button": True, + "use_issues_button": True, + "use_edit_page_button": True, + # Please don't change unless you know what you're doing. + "extra_footer": """ + + Creative Commons License + +
+ These works by + Axim Collaborative, Inc + are licensed under a + Creative Commons Attribution-ShareAlike 4.0 International License. + """ +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. +# " v documentation" by default. +# +# html_title = 'flashcards v0.1.0' + +# A shorter title for the navigation bar. Default is the same as html_title. +# +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# +html_logo = "https://logos.openedx.org/open-edx-logo-color.png" + +# The name of an image file (relative to this directory) to use as a favicon +# of the docs. This file should be a Windows icon file (.ico) being 16x16 +# or 32x32 +# pixels large. +# +html_favicon = "https://logos.openedx.org/open-edx-favicon.ico" + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# +# html_extra_path = [] + +# If not None, a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +# The empty string is equivalent to '%b %d, %Y'. +# +# html_last_updated_fmt = None + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# +# html_additional_pages = {} + +# If false, no module index is generated. +# +# html_domain_indices = True + +# If false, no index is generated. +# +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' +# +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# 'ja' uses this config value. +# 'zh' user can custom change `jieba` dictionary path. +# +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = f'{project}doc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_target = f'{project}.tex' +latex_documents = [ + (top_level_doc, latex_target, documentation_title, + author, 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# +# latex_use_parts = False + +# If true, show page references after internal links. +# +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# +# latex_appendices = [] + +# It false, will not define \strong, \code, itleref, \crossref ... but only +# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added +# packages. +# +# latex_keep_old_macro_names = True + +# If false, no module index is generated. +# +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (top_level_doc, project_title, documentation_title, + [author], 1) +] + +# If true, show URL addresses after external links. +# +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (top_level_doc, project_title, documentation_title, + author, project_title, 'Service for managing and displaying flashcards', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# +# texinfo_appendices = [] + +# If false, no module index is generated. +# +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# +# texinfo_no_detailmenu = False + + +# -- Options for Epub output ---------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project +epub_author = author +epub_publisher = author +epub_copyright = copyright + +# The basename for the epub file. It defaults to the project name. +# epub_basename = project + +# The HTML theme for the epub output. Since the default themes are not +# optimized for small screen space, using the same theme for HTML and epub +# output is usually not wise. This defaults to 'epub', a theme designed to save +# visual space. +# +# epub_theme = 'epub' + +# The language of the text. It defaults to the language option +# or 'en' if the language is not set. +# +# epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +# epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +# +# epub_cover = () + +# A sequence of (type, uri, title) tuples for the guide element of content.opf. +# +# epub_guide = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +# +# epub_pre_files = [] + +# HTML files that should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +# +# epub_post_files = [] + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + +# The depth of the table of contents in toc.ncx. +# +# epub_tocdepth = 3 + +# Allow duplicate toc entries. +# +# epub_tocdup = True + +# Choose between 'default' and 'includehidden'. +# +# epub_tocscope = 'default' + +# Fix unsupported image types using the Pillow. +# +# epub_fix_images = False + +# Scale large images. +# +# epub_max_image_width = 0 + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# +# epub_show_urls = 'inline' + +# If false, no index is generated. +# +# epub_use_index = True + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + 'python': ('https://docs.python.org/3.8', None), +} + + +def on_init(app): # pylint: disable=unused-argument + """ + Run sphinx-apidoc after Sphinx initialization. + + Read the Docs won't run tox or custom shell commands, so we need this to + avoid checking in the generated reStructuredText files. + """ + docs_path = os.path.abspath(os.path.dirname(__file__)) + root_path = os.path.abspath(os.path.join(docs_path, '..')) + apidoc_path = 'sphinx-apidoc' + if hasattr(sys, 'real_prefix'): # Check to see if we are in a virtualenv + # If we are, assemble the path manually + bin_path = os.path.abspath(os.path.join(sys.prefix, 'bin')) + apidoc_path = os.path.join(bin_path, apidoc_path) + check_call([apidoc_path, '-o', docs_path, os.path.join(root_path, 'flashcards'), + os.path.join(root_path, 'flashcards/migrations')]) + + +def setup(app): + """Sphinx extension: run sphinx-apidoc.""" + event = 'builder-inited' + app.connect(event, on_init) diff --git a/docs/decisions.rst b/docs/decisions.rst new file mode 100644 index 0000000..a21903c --- /dev/null +++ b/docs/decisions.rst @@ -0,0 +1,12 @@ +Decisions +######### + +The following `ADRs` are a record of all decisions made as a part of developing this library. + +.. _ADRs: https://open-edx-proposals.readthedocs.io/en/latest/oep-0019-bp-developer-documentation.html#adrs + +.. toctree:: + :maxdepth: 1 + :glob: + + decisions/* diff --git a/docs/decisions/0001-purpose-of-this-repo.rst b/docs/decisions/0001-purpose-of-this-repo.rst new file mode 100644 index 0000000..d67cb89 --- /dev/null +++ b/docs/decisions/0001-purpose-of-this-repo.rst @@ -0,0 +1,57 @@ +0001 Purpose of This Repo +######################### + +Status +****** + +**Draft** + +.. TODO: When ready, update the status from Draft to Provisional or Accepted. + +.. Standard statuses + - **Draft** if the decision is newly proposed and in active discussion + - **Provisional** if the decision is still preliminary and in experimental phase + - **Accepted** *(date)* once it is agreed upon + - **Superseded** *(date)* with a reference to its replacement if a later ADR changes or reverses the decision + + If an ADR has Draft status and the PR is under review, you can either use the intended final status (e.g. Provisional, Accepted, etc.), or you can clarify both the current and intended status using something like the following: "Draft (=> Provisional)". Either of these options is especially useful if the merged status is not intended to be Accepted. + +Context +******* + +TODO: Add context of what led to the creation of this repo. + +.. This section describes the forces at play, including technological, political, social, and project local. These forces are probably in tension, and should be called out as such. The language in this section is value-neutral. It is simply describing facts. + +Decision +******** + +We will create a repository... + +TODO: Clearly state how the context above led to the creation of this repo. + +.. This section describes our response to these forces. It is stated in full sentences, with active voice. "We will …" + +Consequences +************ + +TODO: Add what other things will change as a result of creating this repo. + +.. This section describes the resulting context, after applying the decision. All consequences should be listed here, not just the "positive" ones. A particular decision may have positive, negative, and neutral consequences, but all of them affect the team and project in the future. + +Rejected Alternatives +********************* + +TODO: If applicable, list viable alternatives to creating this new repo and give reasons for why they were rejected. If not applicable, remove section. + +.. This section lists alternate options considered, described briefly, with pros and cons. + +References +********** + +TODO: If applicable, add any references. If not applicable, remove section. + +.. (Optional) List any additional references here that would be useful to the future reader. See `Documenting Architecture Decisions`_ and `OEP-19 on ADRs`_ for further input. + +.. _Documenting Architecture Decisions: https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions +.. _OEP-19 on ADRs: https://open-edx-proposals.readthedocs.io/en/latest/best-practices/oep-0019-bp-developer-documentation.html#adrs diff --git a/docs/decisions/README.rst b/docs/decisions/README.rst new file mode 100644 index 0000000..612ad3b --- /dev/null +++ b/docs/decisions/README.rst @@ -0,0 +1,8 @@ +This directory is a historical record on the architectural decisions we make with this repository as it evolves over time. + +It uses Architecture Decision Records, as described by Michael Nygard in `Documenting Architecture Decisions`_. + +For more information, see `OEP-19's section on ADRs`_. + +.. _Documenting Architecture Decisions: https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions +.. _OEP-19's section on ADRs: https://open-edx-proposals.readthedocs.io/en/latest/best-practices/oep-0019-bp-developer-documentation.html#adrs diff --git a/docs/features.rst b/docs/features.rst new file mode 100644 index 0000000..073bbe9 --- /dev/null +++ b/docs/features.rst @@ -0,0 +1,30 @@ +.. _chapter-features: + +Feature Toggling +################ +All new features/functionality should be released behind a feature gate. This allows us to easily disable features +in the event that an issue is discovered in production. This project uses the +`Waffle `_ library for feature gating. + +Waffle supports three types of feature gates (listed below). We typically use flags and switches since samples are +random, and not ideal for our needs. + + Flag + Enable a feature for specific users, groups, users meeting certain criteria (e.g. authenticated or staff), + or a certain percentage of visitors. + + Switch + Simple boolean, toggling a feature for all users. + + Sample + Toggle the feature for a specified percentage of the time. + + +For information on creating or updating features, refer to the +`Waffle documentation `_. + +Permanent Feature Rollout +************************* +Over time some features may become permanent and no longer need a feature gate around them. In such instances, the +relevant code and tests should be updated to remove the feature gate. Once the code is released, the feature flag/switch +should be deleted. diff --git a/docs/getting_started.rst b/docs/getting_started.rst new file mode 100644 index 0000000..cec5418 --- /dev/null +++ b/docs/getting_started.rst @@ -0,0 +1,18 @@ +Getting Started +############### + +If you have not already done so, create/activate a `virtualenv`_. Unless otherwise stated, assume all terminal code +below is executed within the virtualenv. + +.. _virtualenv: https://virtualenvwrapper.readthedocs.org/en/latest/ + + +Install dependencies +******************** +Dependencies can be installed via the command below. + +.. code-block:: bash + + $ make requirements + + diff --git a/docs/how-tos/index.rst b/docs/how-tos/index.rst new file mode 100644 index 0000000..5147f80 --- /dev/null +++ b/docs/how-tos/index.rst @@ -0,0 +1,2 @@ +How-tos +####### diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..e38b980 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,34 @@ +.. flashcards documentation top level file, created by + sphinx-quickstart on Mon Oct 23 10:30:01 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +flashcards +========== + +Service for managing and displaying flashcards + +Contents: + +.. toctree:: + :maxdepth: 2 + + readme + getting_started + quickstarts/index + concepts/index + how-tos/index + testing + internationalization + modules + decisions + features + references/index + + +Indices and tables +################## + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/internationalization.rst b/docs/internationalization.rst new file mode 100644 index 0000000..9b25877 --- /dev/null +++ b/docs/internationalization.rst @@ -0,0 +1,51 @@ +.. _chapter-i18n: + +Internationalization +#################### +All user-facing text content should be marked for translation. Even if this application is only run in English, our +open source users may choose to use another language. Marking content for translation ensures our users have +this choice. + +Follow the `internationalization coding guidelines`_ in the edX Developer's Guide when developing new features. + +.. _internationalization coding guidelines: https://edx.readthedocs.org/projects/edx-developer-guide/en/latest/internationalization/i18n.html + +Updating Translations +********************* +This project uses `Transifex`_ to translate content. After new features are developed the translation source files +should be pushed to Transifex. Our translation community will translate the content, after which we can retrieve the +translations. + +.. _Transifex: https://www.transifex.com/ + +Pushing source translation files to Transifex requires access to the edx-platform. Request access from the Open Source +Team if you will be pushing translation files. You should also `configure the Transifex client`_ if you have not done so +already. + +.. _configure the Transifex client: https://docs.transifex.com/client/config/ + +The `make` targets listed below can be used to push or pull translations. + +.. list-table:: + :widths: 25 75 + :header-rows: 1 + + * - Target + - Description + * - pull_translations + - Pull translations from Transifex + * - push_translations + - Push source translation files to Transifex + +Fake Translations +***************** +As you develop features it may be helpful to know which strings have been marked for translation, and which are not. +Use the `fake_translations` make target for this purpose. This target will extract all strings marked for translation, +generate fake translations in the Esperanto (eo) language directory, and compile the translations. + +You can trigger the display of the translations by setting your browser's language to Esperanto (eo), and navigating to +a page on the site. Instead of plain English strings, you should see specially-accented English strings that look +like this: + + Thé Fütüré øf Ønlïné Édüçätïøn Ⱡσяєм ι# Før änýøné, änýwhéré, änýtïmé Ⱡσяєм # + diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..8b3a1d1 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,281 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. epub3 to make an epub3 + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. xml to make Docutils-native XML files + echo. pseudoxml to make pseudoxml-XML files for display purposes + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + echo. coverage to run coverage check of the documentation if enabled + echo. dummy to check syntax errors of document sources + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + + +REM Check if sphinx-build is available and fallback to Python version if any +%SPHINXBUILD% 1>NUL 2>NUL +if errorlevel 9009 goto sphinx_python +goto sphinx_ok + +:sphinx_python + +set SPHINXBUILD=python -m sphinx.__init__ +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://sphinx-doc.org/ + exit /b 1 +) + +:sphinx_ok + + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\flashcards.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\flashcards.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "epub3" ( + %SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3 + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub3 file is in %BUILDDIR%/epub3. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +if "%1" == "coverage" ( + %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage + if errorlevel 1 exit /b 1 + echo. + echo.Testing of coverage in the sources finished, look at the ^ +results in %BUILDDIR%/coverage/python.txt. + goto end +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +if "%1" == "dummy" ( + %SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. Dummy builder generates no files. + goto end +) + +:end diff --git a/docs/quickstarts/index.rst b/docs/quickstarts/index.rst new file mode 100644 index 0000000..e3f408f --- /dev/null +++ b/docs/quickstarts/index.rst @@ -0,0 +1,2 @@ +Quick Start +########### diff --git a/docs/readme.rst b/docs/readme.rst new file mode 100644 index 0000000..72a3355 --- /dev/null +++ b/docs/readme.rst @@ -0,0 +1 @@ +.. include:: ../README.rst diff --git a/docs/references/index.rst b/docs/references/index.rst new file mode 100644 index 0000000..ba5ea57 --- /dev/null +++ b/docs/references/index.rst @@ -0,0 +1,2 @@ +References +########## diff --git a/docs/testing.rst b/docs/testing.rst new file mode 100644 index 0000000..e27c27c --- /dev/null +++ b/docs/testing.rst @@ -0,0 +1,44 @@ +.. _chapter-testing: + +Testing +####### + +flashcards has an assortment of test cases and code quality +checks to catch potential problems during development. To run them all in the +version of Python you chose for your virtualenv: + +.. code-block:: bash + + $ make validate + +To run just the unit tests: + +.. code-block:: bash + + $ make test + +To run just the unit tests and check diff coverage + +.. code-block:: bash + + $ make diff_cover + +To run just the code quality checks: + +.. code-block:: bash + + $ make quality + +To run the unit tests under every supported Python version and the code +quality checks: + +.. code-block:: bash + + $ make test-all + +To generate and open an HTML report of how much of the code is covered by +test cases: + +.. code-block:: bash + + $ make coverage diff --git a/flashcards/__init__.py b/flashcards/__init__.py new file mode 100644 index 0000000..72a28ba --- /dev/null +++ b/flashcards/__init__.py @@ -0,0 +1,4 @@ +""" +flashcards module. +""" +__version__ = '0.1.0' diff --git a/flashcards/apps/__init__.py b/flashcards/apps/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/flashcards/apps/api/__init__.py b/flashcards/apps/api/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/flashcards/apps/api/models.py b/flashcards/apps/api/models.py new file mode 100644 index 0000000..ff4afbb --- /dev/null +++ b/flashcards/apps/api/models.py @@ -0,0 +1,4 @@ +# Models that can be shared across multiple versions of the API +# should be created here. As the API evolves, models may become more +# specific to a particular version of the API. In this case, the models +# in question should be moved to versioned sub-package. diff --git a/flashcards/apps/api/serializers.py b/flashcards/apps/api/serializers.py new file mode 100644 index 0000000..6906750 --- /dev/null +++ b/flashcards/apps/api/serializers.py @@ -0,0 +1,4 @@ +# Serializers that can be shared across multiple versions of the API +# should be created here. As the API evolves, serializers may become more +# specific to a particular version of the API. In this case, the serializers +# in question should be moved to versioned sub-package. diff --git a/flashcards/apps/api/tests/__init__.py b/flashcards/apps/api/tests/__init__.py new file mode 100644 index 0000000..81c61f8 --- /dev/null +++ b/flashcards/apps/api/tests/__init__.py @@ -0,0 +1 @@ +# Create your tests in sub-packages prefixed with "test_" (e.g. test_models). diff --git a/flashcards/apps/api/urls.py b/flashcards/apps/api/urls.py new file mode 100644 index 0000000..e60384b --- /dev/null +++ b/flashcards/apps/api/urls.py @@ -0,0 +1,14 @@ +""" +Root API URLs. + +All API URLs should be versioned, so urlpatterns should only +contain namespaces for the active versions of the API. +""" +from django.urls import include, re_path + +from flashcards.apps.api.v1 import urls as v1_urls + +app_name = 'api' +urlpatterns = [ + re_path(r'^v1/', include(v1_urls)), +] diff --git a/flashcards/apps/api/v1/__init__.py b/flashcards/apps/api/v1/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/flashcards/apps/api/v1/tests/__init__.py b/flashcards/apps/api/v1/tests/__init__.py new file mode 100644 index 0000000..d255727 --- /dev/null +++ b/flashcards/apps/api/v1/tests/__init__.py @@ -0,0 +1 @@ +# Create your tests in sub-packages prefixed with "test_" (e.g. test_views). diff --git a/flashcards/apps/api/v1/urls.py b/flashcards/apps/api/v1/urls.py new file mode 100644 index 0000000..8f654b2 --- /dev/null +++ b/flashcards/apps/api/v1/urls.py @@ -0,0 +1,4 @@ +""" API v1 URLs. """ + +app_name = 'v1' +urlpatterns = [] diff --git a/flashcards/apps/api/v1/views.py b/flashcards/apps/api/v1/views.py new file mode 100644 index 0000000..60f00ef --- /dev/null +++ b/flashcards/apps/api/v1/views.py @@ -0,0 +1 @@ +# Create your views here. diff --git a/flashcards/apps/core/__init__.py b/flashcards/apps/core/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/flashcards/apps/core/admin.py b/flashcards/apps/core/admin.py new file mode 100644 index 0000000..763efed --- /dev/null +++ b/flashcards/apps/core/admin.py @@ -0,0 +1,22 @@ +""" Admin configuration for core models. """ + +from django.contrib import admin +from django.contrib.auth.admin import UserAdmin +from django.utils.translation import gettext_lazy as _ + +from flashcards.apps.core.models import User + + +class CustomUserAdmin(UserAdmin): + """ Admin configuration for the custom User model. """ + list_display = ('username', 'email', 'full_name', 'first_name', 'last_name', 'is_staff') + fieldsets = ( + (None, {'fields': ('username', 'password')}), + (_('Personal info'), {'fields': ('full_name', 'first_name', 'last_name', 'email')}), + (_('Permissions'), {'fields': ('is_active', 'is_staff', 'is_superuser', + 'groups', 'user_permissions')}), + (_('Important dates'), {'fields': ('last_login', 'date_joined')}), + ) + + +admin.site.register(User, CustomUserAdmin) diff --git a/flashcards/apps/core/constants.py b/flashcards/apps/core/constants.py new file mode 100644 index 0000000..8a969c7 --- /dev/null +++ b/flashcards/apps/core/constants.py @@ -0,0 +1,7 @@ +""" Constants for the core app. """ + + +class Status: + """Health statuses.""" + OK = "OK" + UNAVAILABLE = "UNAVAILABLE" diff --git a/flashcards/apps/core/context_processors.py b/flashcards/apps/core/context_processors.py new file mode 100644 index 0000000..7d3ba35 --- /dev/null +++ b/flashcards/apps/core/context_processors.py @@ -0,0 +1,9 @@ +""" Core context processors. """ +from django.conf import settings + + +def core(_request): + """ Site-wide context processor. """ + return { + 'platform_name': settings.PLATFORM_NAME + } diff --git a/flashcards/apps/core/migrations/__init__.py b/flashcards/apps/core/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/flashcards/apps/core/models.py b/flashcards/apps/core/models.py new file mode 100644 index 0000000..0227cd3 --- /dev/null +++ b/flashcards/apps/core/models.py @@ -0,0 +1,37 @@ +""" Core models. """ + +from django.contrib.auth.models import AbstractUser +from django.db import models +from django.utils.translation import gettext_lazy as _ + + +class User(AbstractUser): + """ + Custom user model for use with python-social-auth via edx-auth-backends. + + .. pii: Stores full name, username, and email address for a user. + .. pii_types: name, username, email_address + .. pii_retirement: local_api + + """ + full_name = models.CharField(_('Full Name'), max_length=255, blank=True, null=True) + + @property + def access_token(self): + """ + Returns an OAuth2 access token for this user, if one exists; otherwise None. + Assumes user has authenticated at least once with the OAuth2 provider (LMS). + """ + try: + return self.social_auth.first().extra_data['access_token'] # pylint: disable=no-member + except Exception: # pylint: disable=broad-except + return None + + class Meta: + get_latest_by = 'date_joined' + + def get_full_name(self): + return self.full_name or super().get_full_name() + + def __str__(self): + return str(self.get_full_name()) diff --git a/flashcards/apps/core/tests/__init__.py b/flashcards/apps/core/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/flashcards/apps/core/tests/test_context_processors.py b/flashcards/apps/core/tests/test_context_processors.py new file mode 100644 index 0000000..d45b24b --- /dev/null +++ b/flashcards/apps/core/tests/test_context_processors.py @@ -0,0 +1,16 @@ +""" Context processor tests. """ + +from django.test import RequestFactory, TestCase, override_settings + +from flashcards.apps.core.context_processors import core + +PLATFORM_NAME = 'Test Platform' + + +class CoreContextProcessorTests(TestCase): + """ Tests for core.context_processors.core """ + + @override_settings(PLATFORM_NAME=PLATFORM_NAME) + def test_core(self): + request = RequestFactory().get('/') + self.assertDictEqual(core(request), {'platform_name': PLATFORM_NAME}) diff --git a/flashcards/apps/core/tests/test_models.py b/flashcards/apps/core/tests/test_models.py new file mode 100644 index 0000000..f1fd050 --- /dev/null +++ b/flashcards/apps/core/tests/test_models.py @@ -0,0 +1,45 @@ +""" Tests for core models. """ + +from django.test import TestCase +from django_dynamic_fixture import G +from social_django.models import UserSocialAuth + +from flashcards.apps.core.models import User + + +class UserTests(TestCase): + """ User model tests. """ + TEST_CONTEXT = {'foo': 'bar', 'baz': None} + + def test_access_token(self): + user = G(User) + self.assertIsNone(user.access_token) + + social_auth = G(UserSocialAuth, user=user) + self.assertIsNone(user.access_token) + + access_token = 'My voice is my passport. Verify me.' + social_auth.extra_data['access_token'] = access_token + social_auth.save() + self.assertEqual(user.access_token, access_token) + + def test_get_full_name(self): + """ Test that the user model concatenates first and last name if the full name is not set. """ + full_name = 'George Costanza' + user = G(User, full_name=full_name) + self.assertEqual(user.get_full_name(), full_name) + + first_name = 'Jerry' + last_name = 'Seinfeld' + user = G(User, full_name=None, first_name=first_name, last_name=last_name) + expected = '{first_name} {last_name}'.format(first_name=first_name, last_name=last_name) + self.assertEqual(user.get_full_name(), expected) + + user = G(User, full_name=full_name, first_name=first_name, last_name=last_name) + self.assertEqual(user.get_full_name(), full_name) + + def test_string(self): + """Verify that the model's string method returns the user's full name.""" + full_name = 'Bob' + user = G(User, full_name=full_name) + self.assertEqual(str(user), full_name) diff --git a/flashcards/apps/core/tests/test_views.py b/flashcards/apps/core/tests/test_views.py new file mode 100644 index 0000000..bdd8cab --- /dev/null +++ b/flashcards/apps/core/tests/test_views.py @@ -0,0 +1,76 @@ +"""Test core.views.""" + +from unittest import mock + +from django.conf import settings +from django.contrib.auth import get_user_model +from django.db import DatabaseError +from django.test import TestCase +from django.test.utils import override_settings +from django.urls import reverse + +from flashcards.apps.core.constants import Status + +User = get_user_model() + + +class HealthTests(TestCase): + """Tests of the health endpoint.""" + + def test_all_services_available(self): + """Test that the endpoint reports when all services are healthy.""" + self._assert_health(200, Status.OK, Status.OK) + + def test_database_outage(self): + """Test that the endpoint reports when the database is unavailable.""" + with mock.patch('django.db.backends.base.base.BaseDatabaseWrapper.cursor', side_effect=DatabaseError): + self._assert_health(503, Status.UNAVAILABLE, Status.UNAVAILABLE) + + def _assert_health(self, status_code, overall_status, database_status): + """Verify that the response matches expectations.""" + response = self.client.get(reverse('health')) + self.assertEqual(response.status_code, status_code) + self.assertEqual(response['content-type'], 'application/json') + + expected_data = { + 'overall_status': overall_status, + 'detailed_status': { + 'database_status': database_status + } + } + + self.assertJSONEqual(response.content, expected_data) + + +class AutoAuthTests(TestCase): + """ Auto Auth view tests. """ + AUTO_AUTH_PATH = reverse('auto_auth') + + @override_settings(ENABLE_AUTO_AUTH=False) + def test_setting_disabled(self): + """When the ENABLE_AUTO_AUTH setting is False, the view should raise a 404.""" + response = self.client.get(self.AUTO_AUTH_PATH) + self.assertEqual(response.status_code, 404) + + @override_settings(ENABLE_AUTO_AUTH=True) + def test_setting_enabled(self): + """ + When ENABLE_AUTO_AUTH is set to True, the view should create and authenticate + a new User with superuser permissions. + """ + original_user_count = User.objects.count() + response = self.client.get(self.AUTO_AUTH_PATH) + + # Verify that a redirect has occured and that a new user has been created + self.assertEqual(response.status_code, 302) + self.assertEqual(User.objects.count(), original_user_count + 1) + + # Get the latest user + user = User.objects.latest() + + # Verify that the user is logged in and that their username has the expected prefix + self.assertEqual(int(self.client.session['_auth_user_id']), user.pk) + self.assertTrue(user.username.startswith(settings.AUTO_AUTH_USERNAME_PREFIX)) + + # Verify that the user has superuser permissions + self.assertTrue(user.is_superuser) diff --git a/flashcards/apps/core/views.py b/flashcards/apps/core/views.py new file mode 100644 index 0000000..6670c85 --- /dev/null +++ b/flashcards/apps/core/views.py @@ -0,0 +1,89 @@ +""" Core views. """ +import logging +import uuid + +from django.conf import settings +from django.contrib.auth import authenticate, get_user_model, login +from django.db import DatabaseError, connection, transaction +from django.http import Http404, JsonResponse +from django.shortcuts import redirect +from django.views.generic import View +from edx_django_utils.monitoring import ignore_transaction + +from flashcards.apps.core.constants import Status + +logger = logging.getLogger(__name__) +User = get_user_model() + + +@transaction.non_atomic_requests +def health(_): + """Allows a load balancer to verify this service is up. + + Checks the status of the database connection on which this service relies. + + Returns: + HttpResponse: 200 if the service is available, with JSON data indicating the health of each required service + HttpResponse: 503 if the service is unavailable, with JSON data indicating the health of each required service + + Example: + >>> response = requests.get('https://flashcards.edx.org/health') + >>> response.status_code + 200 + >>> response.content + '{"overall_status": "OK", "detailed_status": {"database_status": "OK", "lms_status": "OK"}}' + """ + + # Ignores health check in performance monitoring so as to not artifically inflate our response time metrics + ignore_transaction() + + try: + cursor = connection.cursor() + cursor.execute("SELECT 1") + cursor.fetchone() + cursor.close() + database_status = Status.OK + except DatabaseError: + database_status = Status.UNAVAILABLE + + overall_status = Status.OK if (database_status == Status.OK) else Status.UNAVAILABLE + + data = { + 'overall_status': overall_status, + 'detailed_status': { + 'database_status': database_status, + }, + } + + if overall_status == Status.OK: + return JsonResponse(data) + else: + return JsonResponse(data, status=503) + + +class AutoAuth(View): + """Creates and authenticates a new User with superuser permissions. + + If the ENABLE_AUTO_AUTH setting is not True, returns a 404. + """ + + def get(self, request): + """ + Create a new User. + + Raises Http404 if auto auth is not enabled. + """ + if not getattr(settings, 'ENABLE_AUTO_AUTH', None): + raise Http404 + + username_prefix = getattr(settings, 'AUTO_AUTH_USERNAME_PREFIX', 'auto_auth_') + + # Create a new user with staff permissions + username = password = username_prefix + uuid.uuid4().hex[0:20] + User.objects.create_superuser(username, email=None, password=password) + + # Log in the new user + user = authenticate(username=username, password=password) + login(request, user) + + return redirect('/') diff --git a/flashcards/conf/locale/config.yaml b/flashcards/conf/locale/config.yaml new file mode 100644 index 0000000..d1c618e --- /dev/null +++ b/flashcards/conf/locale/config.yaml @@ -0,0 +1,85 @@ +# Configuration for i18n workflow. + +locales: + - en # English - Source Language + - am # Amharic + - ar # Arabic + - az # Azerbaijani + - bg_BG # Bulgarian (Bulgaria) + - bn_BD # Bengali (Bangladesh) + - bn_IN # Bengali (India) + - bs # Bosnian + - ca # Catalan + - ca@valencia # Catalan (Valencia) + - cs # Czech + - cy # Welsh + - da # Danish + - de_DE # German (Germany) + - el # Greek + - en # English + - en_GB # English (United Kingdom) + # Don't pull these until we figure out why pages randomly display in these locales, + # when the user's browser is in English and the user is not logged in. + # - en@lolcat # LOLCAT English + # - en@pirate # Pirate English + - es_419 # Spanish (Latin America) + - es_AR # Spanish (Argentina) + - es_EC # Spanish (Ecuador) + - es_ES # Spanish (Spain) + - es_MX # Spanish (Mexico) + - es_PE # Spanish (Peru) + - et_EE # Estonian (Estonia) + - eu_ES # Basque (Spain) + - fa # Persian + - fa_IR # Persian (Iran) + - fi_FI # Finnish (Finland) + - fil # Filipino + - fr # French + - gl # Galician + - gu # Gujarati + - he # Hebrew + - hi # Hindi + - hr # Croatian + - hu # Hungarian + - hy_AM # Armenian (Armenia) + - id # Indonesian + - it_IT # Italian (Italy) + - ja_JP # Japanese (Japan) + - kk_KZ # Kazakh (Kazakhstan) + - km_KH # Khmer (Cambodia) + - kn # Kannada + - ko_KR # Korean (Korea) + - lt_LT # Lithuanian (Lithuania) + - ml # Malayalam + - mn # Mongolian + - mr # Marathi + - ms # Malay + - nb # Norwegian Bokmål + - ne # Nepali + - nl_NL # Dutch (Netherlands) + - or # Oriya + - pl # Polish + - pt_BR # Portuguese (Brazil) + - pt_PT # Portuguese (Portugal) + - ro # Romanian + - ru # Russian + - si # Sinhala + - sk # Slovak + - sl # Slovenian + - sq # Albanian + - sr # Serbian + - ta # Tamil + - te # Telugu + - th # Thai + - tr_TR # Turkish (Turkey) + - uk # Ukranian + - ur # Urdu + - uz # Uzbek + - vi # Vietnamese + - zh_CN # Chinese (China) + - zh_HK # Chinese (Hong Kong) + - zh_TW # Chinese (Taiwan) + +# The locales used for fake-accented English, for testing. +dummy_locales: + - eo diff --git a/flashcards/docker_gunicorn_configuration.py b/flashcards/docker_gunicorn_configuration.py new file mode 100644 index 0000000..b8a9d5d --- /dev/null +++ b/flashcards/docker_gunicorn_configuration.py @@ -0,0 +1,57 @@ +""" +gunicorn configuration file: https://docs.gunicorn.org/en/develop/configure.html. +""" +import multiprocessing # pylint: disable=unused-import + +preload_app = True +timeout = 300 +bind = "0.0.0.0:8491" + +workers = 2 + + +def pre_request(worker, req): + """Log requests before they are processed.""" + worker.log.info("%s %s" % (req.method, req.path)) + + +def close_all_caches(): + """ + Close the cache so newly forked workers cannot accidentally share the socket with the parent processes. + + This prevents a race condition in which one worker could get a cache response intended for another worker. + """ + # We do this in a way that is safe for 1.4 and 1.8 while we still have some + # 1.4 installations. + from django.conf import settings # lint-amnesty, pylint: disable=import-outside-toplevel + from django.core import cache as django_cache # lint-amnesty, pylint: disable=import-outside-toplevel + if hasattr(django_cache, 'caches'): + get_cache = django_cache.caches.__getitem__ + else: + get_cache = django_cache.get_cache # pylint: disable=no-member + for cache_name in settings.CACHES: + cache = get_cache(cache_name) + if hasattr(cache, 'close'): + cache.close() + + # The 1.4 global default cache object needs to be closed also: 1.4 + # doesn't ensure you get the same object when requesting the same + # cache. The global default is a separate Python object from the cache + # you get with get_cache("default"), so it will have its own connection + # that needs to be closed. + cache = django_cache.cache + if hasattr(cache, 'close'): + cache.close() + + +def post_fork(server, worker): # pylint: disable=unused-argument + """Close the cache so newly forked workers cannot accidentally share the socket with the parent processes.""" + close_all_caches() + + +def when_ready(server): # pylint: disable=unused-argument + """When running in debug mode, run Django's `check` to better match what `manage.py runserver` does.""" + from django.conf import settings # lint-amnesty, pylint: disable=import-outside-toplevel + from django.core.management import call_command # lint-amnesty, pylint: disable=import-outside-toplevel + if settings.DEBUG: + call_command("check") diff --git a/flashcards/settings/__init__.py b/flashcards/settings/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/flashcards/settings/base.py b/flashcards/settings/base.py new file mode 100644 index 0000000..c12ec6f --- /dev/null +++ b/flashcards/settings/base.py @@ -0,0 +1,243 @@ +"""Settings common to all configurations.""" + +import os +from os.path import abspath, dirname, join + +from corsheaders.defaults import default_headers as corsheaders_default_headers + +from flashcards.settings.utils import get_logger_config + +# PATH vars +PROJECT_ROOT = join(abspath(dirname(__file__)), "..") + + +def root(*path_fragments): + return join(abspath(PROJECT_ROOT), *path_fragments) + + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = os.environ.get('FLASHCARDS_SECRET_KEY', 'insecure-secret-key') + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = False + +ALLOWED_HOSTS = [] + +# Application definition + +INSTALLED_APPS = ( + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', + 'release_util', +) + +THIRD_PARTY_APPS = ( + 'corsheaders', + 'csrf.apps.CsrfAppConfig', # Enables frontend apps to retrieve CSRF tokens + 'rest_framework', + 'rest_framework_swagger', + 'social_django', + 'waffle', +) + +PROJECT_APPS = ( + 'flashcards.apps.core', + 'flashcards.apps.api', +) + +INSTALLED_APPS += THIRD_PARTY_APPS +INSTALLED_APPS += PROJECT_APPS + +MIDDLEWARE = ( + # Resets RequestCache utility for added safety. + 'edx_django_utils.cache.middleware.RequestCacheMiddleware', + + # Monitoring middleware should be immediately after RequestCacheMiddleware + 'edx_django_utils.monitoring.DeploymentMonitoringMiddleware', # python and django version + 'edx_django_utils.monitoring.CookieMonitoringMiddleware', # cookie names (compliance) and sizes + 'edx_django_utils.monitoring.CachedCustomMonitoringMiddleware', # support accumulate & increment + 'edx_django_utils.monitoring.MonitoringMemoryMiddleware', # memory usage + + 'corsheaders.middleware.CorsMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.middleware.locale.LocaleMiddleware', + 'django.middleware.common.CommonMiddleware', + 'edx_rest_framework_extensions.auth.jwt.middleware.JwtAuthCookieMiddleware', + 'django.middleware.csrf.CsrfViewMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + 'django.middleware.clickjacking.XFrameOptionsMiddleware', + 'social_django.middleware.SocialAuthExceptionMiddleware', + 'waffle.middleware.WaffleMiddleware', + # Enables force_django_cache_miss functionality for TieredCache. + 'edx_django_utils.cache.middleware.TieredCacheMiddleware', + # Outputs monitoring metrics for a request. + 'edx_rest_framework_extensions.middleware.RequestCustomAttributesMiddleware', + # Ensures proper DRF permissions in support of JWTs + 'edx_rest_framework_extensions.auth.jwt.middleware.EnsureJWTAuthSettingsMiddleware', +) + +# Enable CORS +CORS_ALLOW_CREDENTIALS = True +CORS_ALLOW_HEADERS = corsheaders_default_headers + ( + 'use-jwt-cookie', +) +CORS_ORIGIN_WHITELIST = [] + +ROOT_URLCONF = 'flashcards.urls' + +# Python dotted path to the WSGI application used by Django's runserver. +WSGI_APPLICATION = 'flashcards.wsgi.application' + +# Database +# https://docs.djangoproject.com/en/3.2/ref/settings/#databases +# Set this value in the environment-specific files (e.g. local.py, production.py, test.py) +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.', + 'NAME': '', + 'USER': '', + 'PASSWORD': '', + 'HOST': '', # Empty for localhost through domain sockets or '127.0.0.1' for localhost through TCP. + 'PORT': '', # Set to empty string for default. + } +} + +# New DB primary keys default to an IntegerField. +DEFAULT_AUTO_FIELD = 'django.db.models.AutoField' + +# Internationalization +# https://docs.djangoproject.com/en/dev/topics/i18n/ + +LANGUAGE_CODE = 'en-us' + +TIME_ZONE = 'UTC' + +USE_I18N = True + +USE_L10N = True + +USE_TZ = True + +LOCALE_PATHS = ( + root('conf', 'locale'), +) + + +# MEDIA CONFIGURATION +# See: https://docs.djangoproject.com/en/dev/ref/settings/#media-root +MEDIA_ROOT = root('media') + +# See: https://docs.djangoproject.com/en/dev/ref/settings/#media-url +MEDIA_URL = '/media/' +# END MEDIA CONFIGURATION + + +# STATIC FILE CONFIGURATION +# See: https://docs.djangoproject.com/en/dev/ref/settings/#static-root +STATIC_ROOT = root('assets') + +# See: https://docs.djangoproject.com/en/dev/ref/settings/#static-url +STATIC_URL = '/static/' + +# See: https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/#std:setting-STATICFILES_DIRS +STATICFILES_DIRS = ( + root('static'), +) + +# TEMPLATE CONFIGURATION +# See: https://docs.djangoproject.com/en/3.2/ref/settings/#templates +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'APP_DIRS': True, + 'DIRS': ( + root('templates'), + ), + 'OPTIONS': { + 'context_processors': ( + 'django.contrib.auth.context_processors.auth', + 'django.template.context_processors.debug', + 'django.template.context_processors.i18n', + 'django.template.context_processors.media', + 'django.template.context_processors.request', + 'django.template.context_processors.static', + 'django.template.context_processors.tz', + 'django.contrib.messages.context_processors.messages', + 'flashcards.apps.core.context_processors.core', + ), + 'debug': True, # Django will only display debug pages if the global DEBUG setting is set to True. + } + }, +] +# END TEMPLATE CONFIGURATION + + +# COOKIE CONFIGURATION +# The purpose of customizing the cookie names is to avoid conflicts when +# multiple Django services are running behind the same hostname. +# Detailed information at: https://docs.djangoproject.com/en/dev/ref/settings/ +SESSION_COOKIE_NAME = 'flashcards_sessionid' +CSRF_COOKIE_NAME = 'flashcards_csrftoken' +LANGUAGE_COOKIE_NAME = 'flashcards_language' +# END COOKIE CONFIGURATION + +CSRF_COOKIE_SECURE = False +CSRF_TRUSTED_ORIGINS = [] + +# AUTHENTICATION CONFIGURATION +LOGIN_URL = '/login/' +LOGOUT_URL = '/logout/' + +AUTH_USER_MODEL = 'core.User' + +AUTHENTICATION_BACKENDS = ( + 'auth_backends.backends.EdXOAuth2', + 'django.contrib.auth.backends.ModelBackend', +) + +ENABLE_AUTO_AUTH = False +AUTO_AUTH_USERNAME_PREFIX = 'auto_auth_' + +SOCIAL_AUTH_STRATEGY = 'auth_backends.strategies.EdxDjangoStrategy' + +# Set these to the correct values for your OAuth2 provider (e.g., LMS) +SOCIAL_AUTH_EDX_OAUTH2_KEY = 'replace-me' +SOCIAL_AUTH_EDX_OAUTH2_SECRET = 'replace-me' +SOCIAL_AUTH_EDX_OAUTH2_URL_ROOT = 'replace-me' +SOCIAL_AUTH_EDX_OAUTH2_LOGOUT_URL = 'replace-me' +BACKEND_SERVICE_EDX_OAUTH2_KEY = 'replace-me' +BACKEND_SERVICE_EDX_OAUTH2_SECRET = 'replace-me' + +JWT_AUTH = { + 'JWT_AUTH_HEADER_PREFIX': 'JWT', + 'JWT_ISSUER': 'http://127.0.0.1:8000/oauth2', + 'JWT_ALGORITHM': 'HS256', + 'JWT_VERIFY_EXPIRATION': True, + 'JWT_PAYLOAD_GET_USERNAME_HANDLER': lambda d: d.get('preferred_username'), + 'JWT_LEEWAY': 1, + 'JWT_DECODE_HANDLER': 'edx_rest_framework_extensions.auth.jwt.decoder.jwt_decode_handler', + 'JWT_PUBLIC_SIGNING_JWK_SET': None, + 'JWT_AUTH_COOKIE': 'edx-jwt-cookie', + 'JWT_AUTH_COOKIE_HEADER_PAYLOAD': 'edx-jwt-cookie-header-payload', + 'JWT_AUTH_COOKIE_SIGNATURE': 'edx-jwt-cookie-signature', +} + +# Request the user's permissions in the ID token +EXTRA_SCOPE = ['permissions'] + +# TODO Set this to another (non-staff, ideally) path. +LOGIN_REDIRECT_URL = '/admin/' +# END AUTHENTICATION CONFIGURATION + + +# OPENEDX-SPECIFIC CONFIGURATION +PLATFORM_NAME = 'Your Platform Name Here' +# END OPENEDX-SPECIFIC CONFIGURATION + +# Set up logging for development use (logging to stdout) +LOGGING = get_logger_config(debug=DEBUG) diff --git a/flashcards/settings/devstack.py b/flashcards/settings/devstack.py new file mode 100644 index 0000000..d055862 --- /dev/null +++ b/flashcards/settings/devstack.py @@ -0,0 +1,60 @@ +"""Settings for devstack use.""" + +from flashcards.settings.local import * # pylint: disable=wildcard-import + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.mysql', + 'NAME': os.environ.get('DB_NAME', 'flashcards'), + 'USER': os.environ.get('DB_USER', 'root'), + 'PASSWORD': os.environ.get('DB_PASSWORD', ''), + 'HOST': os.environ.get('DB_HOST', 'flashcards.db'), + 'PORT': os.environ.get('DB_PORT', 3306), + 'ATOMIC_REQUESTS': False, + 'CONN_MAX_AGE': 60, + } +} + +# Generic OAuth2 variables irrespective of SSO/backend service key types. +OAUTH2_PROVIDER_URL = 'http://edx.devstack.lms:18000/oauth2' + +# OAuth2 variables specific to social-auth/SSO login use case. +SOCIAL_AUTH_EDX_OAUTH2_KEY = os.environ.get('SOCIAL_AUTH_EDX_OAUTH2_KEY', 'flashcards-sso-key') +SOCIAL_AUTH_EDX_OAUTH2_SECRET = os.environ.get('SOCIAL_AUTH_EDX_OAUTH2_SECRET', 'flashcards-sso-secret') +SOCIAL_AUTH_EDX_OAUTH2_ISSUER = os.environ.get('SOCIAL_AUTH_EDX_OAUTH2_ISSUER', 'http://localhost:18000') +SOCIAL_AUTH_EDX_OAUTH2_URL_ROOT = os.environ.get('SOCIAL_AUTH_EDX_OAUTH2_URL_ROOT', 'http://edx.devstack.lms:18000') +SOCIAL_AUTH_EDX_OAUTH2_LOGOUT_URL = os.environ.get('SOCIAL_AUTH_EDX_OAUTH2_LOGOUT_URL', 'http://localhost:18000/logout') +SOCIAL_AUTH_EDX_OAUTH2_PUBLIC_URL_ROOT = os.environ.get( + 'SOCIAL_AUTH_EDX_OAUTH2_PUBLIC_URL_ROOT', 'http://localhost:18000', +) + +# OAuth2 variables specific to backend service API calls. +BACKEND_SERVICE_EDX_OAUTH2_KEY = os.environ.get('BACKEND_SERVICE_EDX_OAUTH2_KEY', 'flashcards-backend-service-key') +BACKEND_SERVICE_EDX_OAUTH2_SECRET = os.environ.get( + 'BACKEND_SERVICE_EDX_OAUTH2_SECRET', + 'flashcards-backend-service-secret' +) + +JWT_AUTH.update({ + 'JWT_SECRET_KEY': 'lms-secret', + 'JWT_ISSUER': 'http://localhost:18000/oauth2', + 'JWT_AUDIENCE': None, + 'JWT_VERIFY_AUDIENCE': False, + 'JWT_PUBLIC_SIGNING_JWK_SET': """ + { + "keys": [ + { + "kty": "RSA", + "kid": "devstack_key", + "n": "smKFSYowG6nNUAdeqH1jQQnH1PmIHphzBmwJ5vRf1vu48BUI5VcVtUWIPqzRK_LDSlZYh9D0YFL0ZTxIrlb6Tn3Xz7pYvpIAeYuQv3_H5p8tbz7Fb8r63c1828wXPITVTv8f7oxx5W3lFFgpFAyYMmROC4Ee9qG5T38LFe8_oAuFCEntimWxN9F3P-FJQy43TL7wG54WodgiM0EgzkeLr5K6cDnyckWjTuZbWI-4ffcTgTZsL_Kq1owa_J2ngEfxMCObnzGy5ZLcTUomo4rZLjghVpq6KZxfS6I1Vz79ZsMVUWEdXOYePCKKsrQG20ogQEkmTf9FT_SouC6jPcHLXw", + "e": "AQAB" + } + ] + } + """, # noqa: E501 + 'JWT_ISSUERS': [{ + 'AUDIENCE': 'lms-key', + 'ISSUER': 'http://localhost:18000/oauth2', + 'SECRET_KEY': 'lms-secret', + }], +}) diff --git a/flashcards/settings/local.py b/flashcards/settings/local.py new file mode 100644 index 0000000..34d7aeb --- /dev/null +++ b/flashcards/settings/local.py @@ -0,0 +1,72 @@ +"""Settings for use in local deployments.""" + +from flashcards.settings.base import * # pylint: disable=wildcard-import + +DEBUG = True + +# CACHE CONFIGURATION +# See: https://docs.djangoproject.com/en/dev/ref/settings/#caches +CACHES = { + 'default': { + 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache', + } +} +# END CACHE CONFIGURATION + +# DATABASE CONFIGURATION +# See: https://docs.djangoproject.com/en/dev/ref/settings/#databases +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': root('default.db'), + 'USER': '', + 'PASSWORD': '', + 'HOST': '', + 'PORT': '', + } +} +# END DATABASE CONFIGURATION + +# EMAIL CONFIGURATION +# See: https://docs.djangoproject.com/en/dev/ref/settings/#email-backend +EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend' +# END EMAIL CONFIGURATION + +# TOOLBAR CONFIGURATION +# See: https://django-debug-toolbar.readthedocs.org/en/latest/installation.html +if os.environ.get('ENABLE_DJANGO_TOOLBAR', False): + INSTALLED_APPS += ( + 'debug_toolbar', + ) + + MIDDLEWARE += ( + 'debug_toolbar.middleware.DebugToolbarMiddleware', + ) + + DEBUG_TOOLBAR_PATCH_SETTINGS = False + +INTERNAL_IPS = ('127.0.0.1',) +# END TOOLBAR CONFIGURATION + +# AUTHENTICATION +# Use a non-SSL URL for authorization redirects +SOCIAL_AUTH_REDIRECT_IS_HTTPS = False + +# Generic OAuth2 variables irrespective of SSO/backend service key types. +OAUTH2_PROVIDER_URL = 'http://localhost:18000/oauth2' + +JWT_AUTH.update({ + 'JWT_ALGORITHM': 'HS256', + 'JWT_SECRET_KEY': SOCIAL_AUTH_EDX_OAUTH2_SECRET, + 'JWT_ISSUER': OAUTH2_PROVIDER_URL, + 'JWT_AUDIENCE': SOCIAL_AUTH_EDX_OAUTH2_KEY, +}) + +ENABLE_AUTO_AUTH = True + +LOGGING = get_logger_config(debug=DEBUG) + +##################################################################### +# Lastly, see if the developer has any local overrides. +if os.path.isfile(join(dirname(abspath(__file__)), 'private.py')): + from .private import * # pylint: disable=import-error,wildcard-import diff --git a/flashcards/settings/private.py.example b/flashcards/settings/private.py.example new file mode 100644 index 0000000..b4e55da --- /dev/null +++ b/flashcards/settings/private.py.example @@ -0,0 +1,5 @@ +SOCIAL_AUTH_EDX_OAUTH2_KEY = 'replace-me' +SOCIAL_AUTH_EDX_OAUTH2_SECRET = 'replace-me' +SOCIAL_AUTH_EDX_OAUTH2_URL_ROOT = 'http://127.0.0.1:8000/oauth' +BACKEND_SERVICE_EDX_OAUTH2_KEY = 'flashcards-backend-service-key' +BACKEND_SERVICE_EDX_OAUTH2_SECRET = 'flashcards-backend-service-secret' diff --git a/flashcards/settings/production.py b/flashcards/settings/production.py new file mode 100644 index 0000000..24d33d4 --- /dev/null +++ b/flashcards/settings/production.py @@ -0,0 +1,57 @@ +"""Settings for production use.""" + +from os import environ + +import yaml + +from flashcards.settings.base import * # pylint: disable=wildcard-import +from flashcards.settings.utils import get_env_setting + +DEBUG = False +TEMPLATE_DEBUG = DEBUG + +ALLOWED_HOSTS = ['*'] + +LOGGING = get_logger_config() + +# Keep track of the names of settings that represent dicts. Instead of overriding the values in base.py, +# the values read from disk should UPDATE the pre-configured dicts. +DICT_UPDATE_KEYS = ('JWT_AUTH',) + +# This may be overridden by the YAML in flashcards_CFG, +# but it should be here as a default. +MEDIA_STORAGE_BACKEND = {} +FILE_STORAGE_BACKEND = {} + +if 'FLASHCARDS_CFG' in environ: + CONFIG_FILE = get_env_setting('FLASHCARDS_CFG') + with open(CONFIG_FILE, encoding='utf-8') as f: + config_from_yaml = yaml.safe_load(f) + + # Remove the items that should be used to update dicts, and apply them separately rather + # than pumping them into the local vars. + dict_updates = {key: config_from_yaml.pop(key, None) for key in DICT_UPDATE_KEYS} + + for key, value in dict_updates.items(): + if value: + vars()[key].update(value) + + vars().update(config_from_yaml) + + # Unpack the media and files storage backend settings for django storages. + # These dicts are not Django settings themselves, but they contain a mapping + # of Django settings. + vars().update(FILE_STORAGE_BACKEND) + vars().update(MEDIA_STORAGE_BACKEND) + +DB_OVERRIDES = { + "PASSWORD": environ.get('DB_MIGRATION_PASS', DATABASES['default']['PASSWORD']), + "ENGINE": environ.get('DB_MIGRATION_ENGINE', DATABASES['default']['ENGINE']), + "USER": environ.get('DB_MIGRATION_USER', DATABASES['default']['USER']), + "NAME": environ.get('DB_MIGRATION_NAME', DATABASES['default']['NAME']), + "HOST": environ.get('DB_MIGRATION_HOST', DATABASES['default']['HOST']), + "PORT": environ.get('DB_MIGRATION_PORT', DATABASES['default']['PORT']), +} + +for override, value in DB_OVERRIDES.items(): + DATABASES['default'][override] = value diff --git a/flashcards/settings/test.py b/flashcards/settings/test.py new file mode 100644 index 0000000..b5125c3 --- /dev/null +++ b/flashcards/settings/test.py @@ -0,0 +1,16 @@ +"""Settings for use during testing.""" + +from flashcards.settings.base import * # pylint: disable=wildcard-import + +# IN-MEMORY TEST DATABASE +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': ':memory:', + 'USER': '', + 'PASSWORD': '', + 'HOST': '', + 'PORT': '', + }, +} +# END IN-MEMORY TEST DATABASE diff --git a/flashcards/settings/utils.py b/flashcards/settings/utils.py new file mode 100644 index 0000000..563a5f4 --- /dev/null +++ b/flashcards/settings/utils.py @@ -0,0 +1,102 @@ +"""Utilities for settings.""" + +import platform +import sys +from os import environ + +from django.core.exceptions import ImproperlyConfigured + + +def get_env_setting(setting): + """Get the environment setting or raise exception.""" + try: + return environ[setting] + except KeyError as exc: + error_msg = "Set the [%s] env variable!" % setting + raise ImproperlyConfigured(error_msg) from exc + + +def get_logger_config( + logging_env="no_env", + debug=False, + service_variant='flashcards', +): + """ + Return the appropriate logging config dictionary. + + You should assign the result of this to the LOGGING var in your settings. + """ + hostname = platform.node().split(".")[0] + syslog_format = ( + "[service_variant={service_variant}]" + "[%(name)s][env:{logging_env}] %(levelname)s " + "[{hostname} %(process)d] [user %(userid)s] [ip %(remoteip)s] [%(filename)s:%(lineno)d] " + "- %(message)s" + ).format( + service_variant=service_variant, + logging_env=logging_env, hostname=hostname + ) + + handlers = ['console'] + + logger_config = { + 'version': 1, + 'disable_existing_loggers': False, + 'formatters': { + 'standard': { + 'format': '%(asctime)s %(levelname)s %(process)d ' + '[%(name)s] [user %(userid)s] [ip %(remoteip)s] %(filename)s:%(lineno)d - %(message)s', + }, + 'syslog_format': {'format': syslog_format}, + 'raw': {'format': '%(message)s'}, + }, + 'filters': { + 'require_debug_false': { + '()': 'django.utils.log.RequireDebugFalse', + }, + 'userid_context': { + '()': 'edx_django_utils.logging.UserIdFilter', + }, + 'remoteip_context': { + '()': 'edx_django_utils.logging.RemoteIpFilter', + } + }, + 'handlers': { + 'console': { + 'level': 'DEBUG' if debug else 'INFO', + 'class': 'logging.StreamHandler', + 'formatter': 'standard', + 'filters': ['userid_context', 'remoteip_context'], + 'stream': sys.stdout, + }, + }, + 'loggers': { + 'django': { + 'handlers': handlers, + 'propagate': True, + 'level': 'INFO' + }, + 'requests': { + 'handlers': handlers, + 'propagate': True, + 'level': 'WARNING' + }, + 'factory': { + 'handlers': handlers, + 'propagate': True, + 'level': 'WARNING' + }, + 'django.request': { + 'handlers': handlers, + 'propagate': True, + 'level': 'WARNING' + }, + '': { + 'handlers': handlers, + 'level': 'DEBUG', + 'propagate': False + }, + } + } + + return logger_config diff --git a/flashcards/static/.keep b/flashcards/static/.keep new file mode 100644 index 0000000..e69de29 diff --git a/flashcards/templates/.keep b/flashcards/templates/.keep new file mode 100644 index 0000000..e69de29 diff --git a/flashcards/urls.py b/flashcards/urls.py new file mode 100644 index 0000000..4441227 --- /dev/null +++ b/flashcards/urls.py @@ -0,0 +1,48 @@ +""" +flashcards URL Configuration. + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/3.2/topics/http/urls/ + +Examples: + +Function views + 1. Add an import: from my_app import views + 2. Add a URL to urlpatterns: url(r'^$', views.home, name='home') + +Class-based views + 1. Add an import: from other_app.views import Home + 2. Add a URL to urlpatterns: url(r'^$', Home.as_view(), name='home') + +Including another URLconf + 1. Add an import: from blog import urls as blog_urls + 2. Add a URL to urlpatterns: url(r'^blog/', include(blog_urls)) +""" + +import os + +from auth_backends.urls import oauth2_urlpatterns +from django.conf import settings +from django.contrib import admin +from django.urls import include, re_path +from rest_framework_swagger.views import get_swagger_view + +from flashcards.apps.api import urls as api_urls +from flashcards.apps.core import views as core_views + +admin.autodiscover() + +urlpatterns = oauth2_urlpatterns + [ + re_path(r'^admin/', admin.site.urls), + re_path(r'^api/', include(api_urls)), + re_path(r'^api-docs/', get_swagger_view(title='flashcards API')), + re_path(r'^auto_auth/$', core_views.AutoAuth.as_view(), name='auto_auth'), + re_path(r'', include('csrf.urls')), # Include csrf urls from edx-drf-extensions + re_path(r'^health/$', core_views.health, name='health'), +] + +if settings.DEBUG and os.environ.get('ENABLE_DJANGO_TOOLBAR', False): # pragma: no cover + # Disable pylint import error because we don't install django-debug-toolbar + # for CI build + import debug_toolbar # pylint: disable=import-error + urlpatterns.append(re_path(r'^__debug__/', include(debug_toolbar.urls))) diff --git a/flashcards/wsgi.py b/flashcards/wsgi.py new file mode 100644 index 0000000..cbd1745 --- /dev/null +++ b/flashcards/wsgi.py @@ -0,0 +1,27 @@ +""" +WSGI config for flashcards. + +It exposes the WSGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/3.2/howto/deployment/wsgi/ +""" +import os +from os.path import abspath, dirname +from sys import path + +from django.conf import settings +from django.contrib.staticfiles.handlers import StaticFilesHandler +from django.core.wsgi import get_wsgi_application + +SITE_ROOT = dirname(dirname(abspath(__file__))) +path.append(SITE_ROOT) + +application = get_wsgi_application() # pylint: disable=invalid-name + +# Allows the gunicorn app to serve static files in development environment. +# Without this, css in django admin will not be served locally. +if settings.DEBUG: + application = StaticFilesHandler(get_wsgi_application()) +else: + application = get_wsgi_application() diff --git a/manage.py b/manage.py new file mode 100644 index 0000000..ff6f707 --- /dev/null +++ b/manage.py @@ -0,0 +1,29 @@ +#!/usr/bin/env python +""" +Django administration utility. +""" + +import os +import sys + +PWD = os.path.abspath(os.path.dirname(__file__)) + +if __name__ == '__main__': + os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'flashcards.settings.local') + sys.path.append(PWD) + try: + from django.core.management import execute_from_command_line + except ImportError: + # The above import may fail for some other reason. Ensure that the + # issue is really that Django is missing to avoid masking other + # exceptions on Python 2. + try: + import django # pylint: disable=unused-import + except ImportError: + raise ImportError( + "Couldn't import Django. Are you sure it's installed and " + "available on your PYTHONPATH environment variable? Did you " + "forget to activate a virtual environment?" + ) from None + raise + execute_from_command_line(sys.argv) diff --git a/provision-flashcards.sh b/provision-flashcards.sh new file mode 100644 index 0000000..fd76443 --- /dev/null +++ b/provision-flashcards.sh @@ -0,0 +1,38 @@ +name="flashcards" +port="8491" + +docker-compose up -d --build + +# Install requirements +# Can be skipped right now because we're using the --build flag on docker-compose. This will need to be changed once we move to devstack. + +# Wait for MySQL +echo "Waiting for MySQL" +until docker exec -i flashcards.db mysql -u root -se "SELECT EXISTS(SELECT 1 FROM mysql.user WHERE user = 'root')" &> /dev/null +do + printf "." + sleep 1 +done +sleep 5 + +# Create the database +docker exec -i flashcards.db mysql -u root -se "CREATE DATABASE flashcards;" + +# Run migrations +echo -e "${GREEN}Running migrations for ${name}...${NC}" +docker exec -t flashcards.app bash -c "cd /edx/app/${name}/ && make migrate" + +# Create superuser +echo -e "${GREEN}Creating super-user for ${name}...${NC}" +docker exec -t flashcards.app bash -c "echo 'from django.contrib.auth import get_user_model; User = get_user_model(); User.objects.create_superuser(\"edx\", \"edx@example.com\", \"edx\") if not User.objects.filter(username=\"edx\").exists() else None' | python /edx/app/${name}/manage.py shell" + +# Provision IDA User in LMS +echo -e "${GREEN}Provisioning ${name}_worker in LMS...${NC}" +docker exec -t edx.devstack.lms bash -c "source /edx/app/edxapp/edxapp_env && python /edx/app/edxapp/edx-platform/manage.py lms --settings=devstack_docker manage_user ${name}_worker ${name}_worker@example.com --staff --superuser" + +# Create the DOT applications - one for single sign-on and one for backend service IDA-to-IDA authentication. +docker exec -t edx.devstack.lms bash -c "source /edx/app/edxapp/edxapp_env && python /edx/app/edxapp/edx-platform/manage.py lms --settings=devstack_docker create_dot_application --grant-type authorization-code --skip-authorization --redirect-uris 'http://localhost:${port}/complete/edx-oauth2/' --client-id '${name}-sso-key' --client-secret '${name}-sso-secret' --scopes 'user_id' ${name}-sso ${name}_worker" +docker exec -t edx.devstack.lms bash -c "source /edx/app/edxapp/edxapp_env && python /edx/app/edxapp/edx-platform/manage.py lms --settings=devstack_docker create_dot_application --grant-type client-credentials --client-id '${name}-backend-service-key' --client-secret '${name}-backend-service-secret' ${name}-backend-service ${name}_worker" + +# Restart enterprise.catalog app and worker containers +docker-compose restart app diff --git a/pylintrc b/pylintrc new file mode 100644 index 0000000..9c537ca --- /dev/null +++ b/pylintrc @@ -0,0 +1,390 @@ +# *************************** +# ** DO NOT EDIT THIS FILE ** +# *************************** +# +# This file was generated by edx-lint: https://github.com/openedx/edx-lint +# +# If you want to change this file, you have two choices, depending on whether +# you want to make a local change that applies only to this repo, or whether +# you want to make a central change that applies to all repos using edx-lint. +# +# Note: If your pylintrc file is simply out-of-date relative to the latest +# pylintrc in edx-lint, ensure you have the latest edx-lint installed +# and then follow the steps for a "LOCAL CHANGE". +# +# LOCAL CHANGE: +# +# 1. Edit the local pylintrc_tweaks file to add changes just to this +# repo's file. +# +# 2. Run: +# +# $ edx_lint write pylintrc +# +# 3. This will modify the local file. Submit a pull request to get it +# checked in so that others will benefit. +# +# +# CENTRAL CHANGE: +# +# 1. Edit the pylintrc file in the edx-lint repo at +# https://github.com/openedx/edx-lint/blob/master/edx_lint/files/pylintrc +# +# 2. install the updated version of edx-lint (in edx-lint): +# +# $ pip install . +# +# 3. Run (in edx-lint): +# +# $ edx_lint write pylintrc +# +# 4. Make a new version of edx_lint, submit and review a pull request with the +# pylintrc update, and after merging, update the edx-lint version and +# publish the new version. +# +# 5. In your local repo, install the newer version of edx-lint. +# +# 6. Run: +# +# $ edx_lint write pylintrc +# +# 7. This will modify the local file. Submit a pull request to get it +# checked in so that others will benefit. +# +# +# +# +# +# STAY AWAY FROM THIS FILE! +# +# +# +# +# +# SERIOUSLY. +# +# ------------------------------ +# Generated by edx-lint version: 5.3.4 +# ------------------------------ +[MASTER] +ignore = ,migrations, settings, wsgi.py +persistent = yes +load-plugins = edx_lint.pylint,pylint_django,pylint_celery + +[MESSAGES CONTROL] +enable = + blacklisted-name, + line-too-long, + + abstract-class-instantiated, + abstract-method, + access-member-before-definition, + anomalous-backslash-in-string, + anomalous-unicode-escape-in-string, + arguments-differ, + assert-on-tuple, + assigning-non-slot, + assignment-from-no-return, + assignment-from-none, + attribute-defined-outside-init, + bad-except-order, + bad-format-character, + bad-format-string-key, + bad-format-string, + bad-open-mode, + bad-reversed-sequence, + bad-staticmethod-argument, + bad-str-strip-call, + bad-super-call, + binary-op-exception, + boolean-datetime, + catching-non-exception, + cell-var-from-loop, + confusing-with-statement, + continue-in-finally, + dangerous-default-value, + duplicate-argument-name, + duplicate-bases, + duplicate-except, + duplicate-key, + expression-not-assigned, + format-combined-specification, + format-needs-mapping, + function-redefined, + global-variable-undefined, + import-error, + import-self, + inconsistent-mro, + inherit-non-class, + init-is-generator, + invalid-all-object, + invalid-format-index, + invalid-length-returned, + invalid-sequence-index, + invalid-slice-index, + invalid-slots-object, + invalid-slots, + invalid-unary-operand-type, + logging-too-few-args, + logging-too-many-args, + logging-unsupported-format, + lost-exception, + method-hidden, + misplaced-bare-raise, + misplaced-future, + missing-format-argument-key, + missing-format-attribute, + missing-format-string-key, + no-member, + no-method-argument, + no-name-in-module, + no-self-argument, + no-value-for-parameter, + non-iterator-returned, + non-parent-method-called, + nonexistent-operator, + not-a-mapping, + not-an-iterable, + not-callable, + not-context-manager, + not-in-loop, + pointless-statement, + pointless-string-statement, + raising-bad-type, + raising-non-exception, + redefined-builtin, + redefined-outer-name, + redundant-keyword-arg, + repeated-keyword, + return-arg-in-generator, + return-in-init, + return-outside-function, + signature-differs, + super-init-not-called, + super-method-not-called, + syntax-error, + test-inherits-tests, + too-few-format-args, + too-many-format-args, + too-many-function-args, + translation-of-non-string, + truncated-format-string, + undefined-all-variable, + undefined-loop-variable, + undefined-variable, + unexpected-keyword-arg, + unexpected-special-method-signature, + unpacking-non-sequence, + unreachable, + unsubscriptable-object, + unsupported-binary-operation, + unsupported-membership-test, + unused-format-string-argument, + unused-format-string-key, + used-before-assignment, + using-constant-test, + yield-outside-function, + + astroid-error, + fatal, + method-check-failed, + parse-error, + raw-checker-failed, + + empty-docstring, + invalid-characters-in-docstring, + missing-docstring, + wrong-spelling-in-comment, + wrong-spelling-in-docstring, + + unused-argument, + unused-import, + unused-variable, + + eval-used, + exec-used, + + bad-classmethod-argument, + bad-mcs-classmethod-argument, + bad-mcs-method-argument, + bare-except, + broad-except, + consider-iterating-dictionary, + consider-using-enumerate, + global-at-module-level, + global-variable-not-assigned, + literal-used-as-attribute, + logging-format-interpolation, + logging-not-lazy, + multiple-imports, + multiple-statements, + no-classmethod-decorator, + no-staticmethod-decorator, + protected-access, + redundant-unittest-assert, + reimported, + simplifiable-if-statement, + simplifiable-range, + singleton-comparison, + superfluous-parens, + unidiomatic-typecheck, + unnecessary-lambda, + unnecessary-pass, + unnecessary-semicolon, + unneeded-not, + useless-else-on-loop, + wrong-assert-type, + + deprecated-method, + deprecated-module, + + too-many-boolean-expressions, + too-many-nested-blocks, + too-many-statements, + + wildcard-import, + wrong-import-order, + wrong-import-position, + + missing-final-newline, + mixed-line-endings, + trailing-newlines, + trailing-whitespace, + unexpected-line-ending-format, + + bad-inline-option, + bad-option-value, + deprecated-pragma, + unrecognized-inline-option, + useless-suppression, +disable = + bad-indentation, + broad-exception-raised, + consider-using-f-string, + duplicate-code, + file-ignored, + fixme, + global-statement, + invalid-name, + locally-disabled, + no-else-return, + suppressed-message, + too-few-public-methods, + too-many-ancestors, + too-many-arguments, + too-many-branches, + too-many-instance-attributes, + too-many-lines, + too-many-locals, + too-many-public-methods, + too-many-return-statements, + ungrouped-imports, + unspecified-encoding, + unused-wildcard-import, + use-maxsplit-arg, + + feature-toggle-needs-doc, + illegal-waffle-usage, + + logging-fstring-interpolation, + invalid-name, + django-not-configured, + consider-using-with, + bad-option-value, + +[REPORTS] +output-format = text +reports = no +score = no + +[BASIC] +module-rgx = (([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ +const-rgx = (([A-Z_][A-Z0-9_]*)|(__.*__)|log|urlpatterns|logger|User)$ +class-rgx = [A-Z_][a-zA-Z0-9]+$ +function-rgx = ([a-z_][a-z0-9_]{2,40}|test_[a-z0-9_]+)$ +method-rgx = ([a-z_][a-z0-9_]{2,40}|setUp|set[Uu]pClass|tearDown|tear[Dd]ownClass|assert[A-Z]\w*|maxDiff|test_[a-z0-9_]+)$ +attr-rgx = [a-z_][a-z0-9_]{2,30}$ +argument-rgx = [a-z_][a-z0-9_]{2,30}$ +variable-rgx = [a-z_][a-z0-9_]{2,30}$ +class-attribute-rgx = ([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ +inlinevar-rgx = [A-Za-z_][A-Za-z0-9_]*$ +good-names = f,i,j,k,db,ex,Run,_,__ +bad-names = foo,bar,baz,toto,tutu,tata +no-docstring-rgx = __.*__$|test_.+|setUp$|setUpClass$|tearDown$|tearDownClass$|Meta$ +docstring-min-length = 5 + +[FORMAT] +max-line-length = 120 +ignore-long-lines = ^\s*(# )?((?)|(\.\. \w+: .*))$ +single-line-if-stmt = no +max-module-lines = 1000 +indent-string = ' ' + +[MISCELLANEOUS] +notes = FIXME,XXX,TODO + +[SIMILARITIES] +min-similarity-lines = 4 +ignore-comments = yes +ignore-docstrings = yes +ignore-imports = no + +[TYPECHECK] +ignore-mixin-members = yes +ignored-classes = SQLObject +unsafe-load-any-extension = yes +generated-members = + REQUEST, + acl_users, + aq_parent, + objects, + DoesNotExist, + can_read, + can_write, + get_url, + size, + content, + status_code, + create, + build, + fields, + tag, + org, + course, + category, + name, + revision, + _meta, + +[VARIABLES] +init-import = no +dummy-variables-rgx = _|dummy|unused|.*_unused +additional-builtins = + +[CLASSES] +defining-attr-methods = __init__,__new__,setUp +valid-classmethod-first-arg = cls +valid-metaclass-classmethod-first-arg = mcs + +[DESIGN] +max-args = 5 +ignored-argument-names = _.* +max-locals = 15 +max-returns = 6 +max-branches = 12 +max-statements = 50 +max-parents = 7 +max-attributes = 7 +min-public-methods = 2 +max-public-methods = 20 + +[IMPORTS] +deprecated-modules = regsub,TERMIOS,Bastion,rexec +import-graph = +ext-import-graph = +int-import-graph = + +[EXCEPTIONS] +overgeneral-exceptions = builtins.Exception + +# 89d069bdd9bba6c582a7280c97111820d20515e9 diff --git a/pylintrc_tweaks b/pylintrc_tweaks new file mode 100644 index 0000000..a82ef2f --- /dev/null +++ b/pylintrc_tweaks @@ -0,0 +1,12 @@ +[MASTER] +ignore+= ,migrations, settings, wsgi.py + +[BASIC] +const-rgx = (([A-Z_][A-Z0-9_]*)|(__.*__)|log|urlpatterns|logger|User)$ + +[MESSAGES CONTROL] +DISABLE+= + invalid-name, + django-not-configured, + consider-using-with, + bad-option-value, diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..d119713 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +# This file is here because many Platforms as a Service look for +# requirements.txt in the root directory of a project. +-r requirements/production.txt diff --git a/requirements/base.in b/requirements/base.in new file mode 100644 index 0000000..43abcc9 --- /dev/null +++ b/requirements/base.in @@ -0,0 +1,16 @@ +# Core requirements for using this application +-c constraints.txt + +Django # Web application framework +django-cors-headers +django-extensions +django-rest-swagger +django-waffle +djangorestframework +edx-auth-backends +edx-django-utils +edx-django-release-util +edx-drf-extensions +edx-rest-api-client +mysqlclient +pytz diff --git a/requirements/ci.in b/requirements/ci.in new file mode 100644 index 0000000..3797849 --- /dev/null +++ b/requirements/ci.in @@ -0,0 +1,6 @@ +# Requirements for running tests in CI + +-c constraints.txt + +tox # Virtualenv management for tests +tox-battery # Makes tox aware of requirements file changes diff --git a/requirements/constraints.txt b/requirements/constraints.txt new file mode 100644 index 0000000..2ebd6ea --- /dev/null +++ b/requirements/constraints.txt @@ -0,0 +1,14 @@ +# Version constraints for pip-installation. +# +# This file doesn't install any packages. It specifies version constraints +# that will be applied if a package is needed. +# +# When pinning something here, please provide an explanation of why. Ideally, +# link to other information that will help people in the future to remove the +# pin when possible. Writing an issue against the offending project and +# linking to it here is good. + +# Common constraints for edx repos +-c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt + + diff --git a/requirements/dev.in b/requirements/dev.in new file mode 100644 index 0000000..c1db14a --- /dev/null +++ b/requirements/dev.in @@ -0,0 +1,8 @@ +# Additional requirements for development of this application + +-r pip-tools.txt # pip-tools and its deps, for managing requirements files +-r validation.txt # Core, testing, and quality check dependencies + +diff-cover # Changeset diff test coverage +edx-i18n-tools # For i18n_tool dummy +django-debug-toolbar # For debugging Django diff --git a/requirements/doc.in b/requirements/doc.in new file mode 100644 index 0000000..a8b0290 --- /dev/null +++ b/requirements/doc.in @@ -0,0 +1,10 @@ +# Requirements for documentation validation +-c constraints.txt + +-r test.txt # Core and testing dependencies for this package + +doc8 # reStructuredText style checker +sphinx-book-theme # Common theme for all Open edX projects +twine # Validates README.rst for usage on PyPI +build # Needed to build the wheel for twine check +Sphinx # Documentation builder diff --git a/requirements/monitoring/requirements.txt b/requirements/monitoring/requirements.txt new file mode 100644 index 0000000..22f1248 --- /dev/null +++ b/requirements/monitoring/requirements.txt @@ -0,0 +1,9 @@ +# This requirements.txt file is meant to pull in other requirements.txt files so that +# dependency monitoring tools like gemnasium.com can easily process them. + +# It can not be used to do the full installation because it is not in the correct +# order. + +-r ../dev.txt # Includes validation requirements +-r ../optional.txt +-r ../production.txt diff --git a/requirements/optional.txt b/requirements/optional.txt new file mode 100644 index 0000000..9870eb7 --- /dev/null +++ b/requirements/optional.txt @@ -0,0 +1 @@ +newrelic diff --git a/requirements/pip-tools.in b/requirements/pip-tools.in new file mode 100644 index 0000000..0295d2c --- /dev/null +++ b/requirements/pip-tools.in @@ -0,0 +1,5 @@ +# Just the dependencies to run pip-tools, mainly for the "upgrade" make target + +-c constraints.txt + +pip-tools # Contains pip-compile, used to generate pip requirements files diff --git a/requirements/pip-tools.txt b/requirements/pip-tools.txt new file mode 100644 index 0000000..4445376 --- /dev/null +++ b/requirements/pip-tools.txt @@ -0,0 +1,31 @@ +# +# This file is autogenerated by pip-compile with Python 3.8 +# by the following command: +# +# make upgrade +# +build==1.0.3 + # via pip-tools +click==8.1.7 + # via pip-tools +importlib-metadata==6.8.0 + # via build +packaging==23.2 + # via build +pip-tools==7.3.0 + # via -r python-template/placeholder_repo_name_0/requirements/pip-tools.in +pyproject-hooks==1.0.0 + # via build +tomli==2.0.1 + # via + # build + # pip-tools + # pyproject-hooks +wheel==0.41.2 + # via pip-tools +zipp==3.17.0 + # via importlib-metadata + +# The following packages are considered to be unsafe in a requirements file: +# pip +# setuptools diff --git a/requirements/pip.in b/requirements/pip.in new file mode 100644 index 0000000..716c6f2 --- /dev/null +++ b/requirements/pip.in @@ -0,0 +1,6 @@ +# Core dependencies for installing other packages +-c constraints.txt + +pip +setuptools +wheel diff --git a/requirements/pip.txt b/requirements/pip.txt new file mode 100644 index 0000000..a99625d --- /dev/null +++ b/requirements/pip.txt @@ -0,0 +1,14 @@ +# +# This file is autogenerated by pip-compile with Python 3.8 +# by the following command: +# +# make upgrade +# +wheel==0.41.2 + # via -r python-template/placeholder_repo_name_0/requirements/pip.in + +# The following packages are considered to be unsafe in a requirements file: +pip==23.2.1 + # via -r python-template/placeholder_repo_name_0/requirements/pip.in +setuptools==68.2.2 + # via -r python-template/placeholder_repo_name_0/requirements/pip.in diff --git a/requirements/private.readme b/requirements/private.readme new file mode 100644 index 0000000..5600a10 --- /dev/null +++ b/requirements/private.readme @@ -0,0 +1,15 @@ +# If there are any Python packages you want to keep in your virtualenv beyond +# those listed in the official requirements files, create a "private.in" file +# and list them there. Generate the corresponding "private.txt" file pinning +# all of their indirect dependencies to specific versions as follows: + +# pip-compile private.in + +# This allows you to use "pip-sync" without removing these packages: + +# pip-sync requirements/*.txt + +# "private.in" and "private.txt" aren't checked into git to avoid merge +# conflicts, and the presence of this file allows "private.*" to be +# included in scripted pip-sync usage without requiring that those files be +# created first. diff --git a/requirements/production.in b/requirements/production.in new file mode 100644 index 0000000..292fe18 --- /dev/null +++ b/requirements/production.in @@ -0,0 +1,8 @@ +# Packages required in a production environment +-r base.txt + +gevent +gunicorn +mysqlclient +python-memcached +PyYAML>=5.1 diff --git a/requirements/quality.in b/requirements/quality.in new file mode 100644 index 0000000..d477386 --- /dev/null +++ b/requirements/quality.in @@ -0,0 +1,10 @@ +# Requirements for code quality checks +-c constraints.txt + +-r test.txt # Core and testing dependencies for this package + +edx-lint # edX pylint rules and plugins +isort # to standardize order of imports +pycodestyle # PEP 8 compliance validation +pydocstyle # PEP 257 compliance validation +twine # Utility for publishing Python packages on PyPI. diff --git a/requirements/test.in b/requirements/test.in new file mode 100644 index 0000000..091f47c --- /dev/null +++ b/requirements/test.in @@ -0,0 +1,12 @@ +# Requirements for test runs. + +-c constraints.txt +-r base.txt # Core dependencies for this package + +code-annotations +coverage +django-dynamic-fixture # library to create dynamic model instances for testing purposes +edx-lint +pytest-cov +pytest-django +tox diff --git a/requirements/validation.in b/requirements/validation.in new file mode 100644 index 0000000..cf36778 --- /dev/null +++ b/requirements/validation.in @@ -0,0 +1,4 @@ +# Requirements for validation (testing, code quality). + +-r quality.txt +-r test.txt diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..b040667 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,6 @@ +[isort] +indent=' ' +line_length=120 +multi_line_output=3 +skip= + migrations diff --git a/test_utils/__init__.py b/test_utils/__init__.py new file mode 100644 index 0000000..7961e47 --- /dev/null +++ b/test_utils/__init__.py @@ -0,0 +1,10 @@ +""" +Test utilities. + +Since pytest discourages putting __init__.py into testdirectory +(i.e. making tests a package) one cannot import from anywhere +under tests folder. However, some utility classes/methods might be useful +in multiple test modules (i.e. factoryboy factories, base test classes). + +So this package is the place to put them. +""" diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..f0b2e4b --- /dev/null +++ b/tox.ini @@ -0,0 +1,96 @@ +[tox] +envlist = py39-django{42}, quality, docs, pii_check +skipsdist = true + +[doc8] +; D001 = Line too long +ignore = D001 + +[pycodestyle] +exclude = .git,.tox,migrations +max-line-length = 120 + +[pydocstyle] +; D101 = Missing docstring in public class +; D200 = One-line docstring should fit on one line with quotes +; D203 = 1 blank line required before class docstring +; D212 = Multi-line docstring summary should start at the first line +; D215 = Section underline is over-indented (numpy style) +; D404 = First word of the docstring should not be This (numpy style) +; D405 = Section name should be properly capitalized (numpy style) +; D406 = Section name should end with a newline (numpy style) +; D407 = Missing dashed underline after section (numpy style) +; D408 = Section underline should be in the line following the section's name (numpy style) +; D409 = Section underline should match the length of its name (numpy style) +; D410 = Missing blank line after section (numpy style) +; D411 = Missing blank line before section (numpy style) +; D412 = No blank lines allowed between a section header and its content (numpy style) +; D413 = Missing blank line after last section (numpy style) +; D414 = Section has no content (numpy style) +ignore = D101,D200,D203,D212,D215,D404,D405,D406,D407,D408,D409,D410,D411,D412,D413,D414 +match-dir = (?!migrations) + +[pytest] +DJANGO_SETTINGS_MODULE = flashcards.settings.test +addopts = --cov flashcards --cov-report term-missing --cov-report xml +norecursedirs = .* docs requirements site-packages + +# Filter depr warnings coming from packages that we can't control. +filterwarnings = + ignore:.*urlresolvers is deprecated in favor of.*:DeprecationWarning:auth_backends.views:5 + ignore:.*invalid escape sequence.*:DeprecationWarning:.*(newrelic|uritemplate|psutil).* + ignore:.*the imp module is deprecated in favour of importlib.*:DeprecationWarning:.*distutils.* + +[testenv] +deps = + django42: Django>=4.2,<5.0 + -r{toxinidir}/requirements/test.txt +commands = + pytest {posargs} + +[testenv:docs] +setenv = + DJANGO_SETTINGS_MODULE = flashcards.settings.test + PYTHONPATH = {toxinidir} + # Adding the option here instead of as a default in the docs Makefile because that Makefile is generated by shpinx. + SPHINXOPTS = -W +whitelist_externals = + make + rm +deps = + -r{toxinidir}/requirements/doc.txt +commands = + doc8 --ignore-path docs/_build README.rst docs + rm -f docs/flashcards.rst + rm -f docs/modules.rst + make -e -C docs clean + make -e -C docs html + +[testenv:translations] +whitelist_externals = + make +deps = + -r{toxinidir}/requirements/dev.txt +commands = + make validate_translations + +[testenv:quality] +whitelist_externals = + make +deps = + -r{toxinidir}/requirements/quality.txt +commands = + pylint flashcards test_utils manage.py + pycodestyle flashcards manage.py + pydocstyle flashcards manage.py + isort --check-only --diff test_utils flashcards manage.py + make selfcheck + +[testenv:pii_check] +setenv = + DJANGO_SETTINGS_MODULE = flashcards.settings.test +deps = + -r{toxinidir}/requirements/test.txt +commands = + code_annotations django_find_annotations --config_file .pii_annotations.yml --lint --report --coverage +