-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 13e317d
Showing
54 changed files
with
3,492 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
[run] | ||
branch = True | ||
data_file = .coverage | ||
source=edx_course_team_api | ||
omit = | ||
test_settings | ||
*migrations* | ||
*admin.py | ||
*static* | ||
*templates* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
# *************************** | ||
# ** DO NOT EDIT THIS FILE ** | ||
# *************************** | ||
# | ||
# This file was generated by edx-lint: http://github.com/edx/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. | ||
# | ||
# 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/edx/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): | ||
# | ||
# # uses .editorconfig_tweaks from edx-lint for linting in edx-lint | ||
# # NOTE: Use Python 3.x, which no longer includes comments in the output file | ||
# $ 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 by | ||
# creating a new tag in the repo (uses pbr). | ||
# | ||
# 5. In your local repo, install the newer version of edx-lint. | ||
# | ||
# 6. Run: | ||
# | ||
# # uses local .editorconfig_tweaks | ||
# $ 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. | ||
# | ||
# ------------------------------ | ||
[*] | ||
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 | ||
|
||
[*.rst] | ||
max_line_length = 79 | ||
|
||
# 01d24285b953f74272f86b1e42a0235315085e59 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
**Description:** Describe in a couple of sentences what this PR adds | ||
|
||
**JIRA:** Link to JIRA ticket | ||
|
||
**Dependencies:** dependencies on other outstanding PRs, issues, etc. | ||
|
||
**Merge deadline:** List merge deadline (if any) | ||
|
||
**Installation instructions:** List any non-trivial installation | ||
instructions. | ||
|
||
**Testing instructions:** | ||
|
||
1. Open page A | ||
2. Do thing B | ||
3. Expect C to happen | ||
4. If D happened instead - check failed. | ||
|
||
**Reviewers:** | ||
- [ ] tag reviewer | ||
- [ ] tag reviewer | ||
|
||
**Merge checklist:** | ||
- [ ] All reviewers approved | ||
- [ ] CI build is green | ||
- [ ] Version bumped | ||
- [ ] Changelog record added | ||
- [ ] Documentation updated (not only docstrings) | ||
- [ ] Commits are squashed | ||
|
||
**Post merge:** | ||
- [ ] Create a tag | ||
- [ ] Check new version is pushed to PyPI after tag-triggered build is | ||
finished. | ||
- [ ] Delete working branch (if not needed anymore) | ||
|
||
**Author concerns:** List any concerns about this PR - inelegant | ||
solutions, hacks, quick-and-dirty implementations, concerns about | ||
migrations, etc. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
*.py[cod] | ||
__pycache__ | ||
.pytest_cache | ||
|
||
# C extensions | ||
*.so | ||
|
||
# Packages | ||
*.egg | ||
*.egg-info | ||
/dist | ||
/build | ||
/eggs | ||
/parts | ||
/bin | ||
/var | ||
/sdist | ||
/develop-eggs | ||
/.installed.cfg | ||
/lib | ||
/lib64 | ||
|
||
# Installer logs | ||
pip-log.txt | ||
|
||
# Unit test / coverage reports | ||
.cache/ | ||
.pytest_cache/ | ||
.coverage | ||
.coverage.* | ||
.tox | ||
coverage.xml | ||
htmlcov/ | ||
|
||
|
||
|
||
# The Silver Searcher | ||
.agignore | ||
|
||
# OS X artifacts | ||
*.DS_Store | ||
|
||
# Logging | ||
log/ | ||
logs/ | ||
chromedriver.log | ||
ghostdriver.log | ||
|
||
# Complexity | ||
output/*.html | ||
output/*/index.html | ||
|
||
# Sphinx | ||
docs/_build | ||
docs/modules.rst | ||
docs/edx_course_team_api.rst | ||
docs/edx_course_team_api.*.rst | ||
|
||
# Private requirements | ||
requirements/private.in | ||
requirements/private.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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.5 | ||
install: | ||
- requirements: requirements/docs.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# Config file for automatic testing at travis-ci.org | ||
# To connect a new edX repository to Travis, see | ||
# https://openedx.atlassian.net/wiki/spaces/EdxOps/pages/157464369/How+to+connect+a+repository+to+Travis+CI | ||
# | ||
# Be sure to change the Travis settings in the web UI to enable both | ||
# "Build pushed branches" and "Build pushed pull requests". | ||
|
||
language: python | ||
|
||
python: | ||
- 3.5 | ||
- 3.8 | ||
|
||
env: | ||
- TOXENV=django22 | ||
- TOXENV=django30 | ||
|
||
matrix: | ||
include: | ||
- python: 3.5 | ||
env: TOXENV=quality | ||
- python: 3.5 | ||
env: TOXENV=docs | ||
- python: 3.5 | ||
env: TOXENV=pii_check | ||
|
||
cache: | ||
- pip | ||
|
||
before_install: | ||
- pip install --upgrade pip | ||
|
||
install: | ||
- pip install -r requirements/travis.txt | ||
|
||
script: | ||
- tox | ||
|
||
after_success: | ||
- codecov | ||
|
||
# Set token via "travis encrypt --add deploy.password"; for details, see | ||
# https://docs.travis-ci.com/user/deployment/pypi | ||
deploy: | ||
provider: pypi | ||
user: "__token__" | ||
distributions: sdist bdist_wheel | ||
on: | ||
tags: true | ||
condition: '$TOXENV = quality' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
Change Log | ||
---------- | ||
|
||
.. | ||
All enhancements and patches to edx_course_team_api will be documented | ||
in this file. It adheres to the structure of https://keepachangelog.com/ , | ||
but in reStructuredText instead of Markdown (for ease of incorporation into | ||
Sphinx documentation and the PyPI description). | ||
This project adheres to Semantic Versioning (https://semver.org/). | ||
|
||
.. There should always be an "Unreleased" section for changes pending release. | ||
Unreleased | ||
~~~~~~~~~~ | ||
|
||
* | ||
|
||
[0.1.0] - 2020-10-26 | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
Added | ||
_____ | ||
|
||
* First release on PyPI. |
Oops, something went wrong.