Skip to content

Commit a8b37d0

Browse files
committed
add project resources
1 parent 39315a3 commit a8b37d0

File tree

11 files changed

+1032
-9
lines changed

11 files changed

+1032
-9
lines changed

.flake8

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[flake8]
2+
ignore = E203, E266, E501, W503, F403, F401
3+
max-line-length = 120
4+
max-complexity = 18
5+
select = B,C,E,F,W,T4,B9

.github/FUNDING.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# These are supported funding model platforms
2+
3+
github: lpm0073
4+
patreon: FullStackWithLawrence

.gitignore

Lines changed: 152 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,152 @@
1-
.DS_Store
1+
.DS_Store
2+
.ipynb_checkpoints
3+
4+
.env
5+
# .gitignore for edx-platform.
6+
# There's a lot here, please try to keep it organized.
7+
8+
### Files private to developers
9+
10+
# Files that should be git-ignored, but are hand-edited or otherwise valued,
11+
# and so should not be destroyed by "make clean".
12+
# start-noclean
13+
requirements/private.txt
14+
requirements/edx/private.in
15+
requirements/edx/private.txt
16+
lms/envs/private.py
17+
cms/envs/private.py
18+
# end-noclean
19+
20+
### Python artifacts
21+
*.pyc
22+
23+
### Editor and IDE artifacts
24+
*~
25+
*.swp
26+
*.orig
27+
/nbproject
28+
.idea/
29+
.redcar/
30+
codekit-config.json
31+
.pycharm_helpers/
32+
/_mac/*
33+
/IntelliLang.xml
34+
/conda_packages.xml
35+
/databaseSettings.xml
36+
/diff.xml
37+
/debugger.xml
38+
/editor.xml
39+
/ide.general.xml
40+
/inspection/Default.xml
41+
/other.xml
42+
/packages.xml
43+
/web-browsers.xml
44+
45+
### NFS artifacts
46+
.nfs*
47+
48+
### OS X artifacts
49+
*.DS_Store
50+
.AppleDouble
51+
:2e_*
52+
:2e#
53+
54+
### Internationalization artifacts
55+
*.mo
56+
*.po
57+
*.prob
58+
*.dup
59+
!django.po
60+
!django.mo
61+
!djangojs.po
62+
!djangojs.mo
63+
conf/locale/en/LC_MESSAGES/*.mo
64+
conf/locale/fake*/LC_MESSAGES/*.po
65+
conf/locale/fake*/LC_MESSAGES/*.mo
66+
# this was a mistake in i18n_tools, now fixed.
67+
conf/locale/messages.mo
68+
69+
### Testing artifacts
70+
.testids/
71+
.noseids
72+
nosetests.xml
73+
.cache/
74+
.coverage
75+
.coverage.*
76+
coverage.xml
77+
cover/
78+
cover_html/
79+
reports/
80+
jscover.log
81+
jscover.log.*
82+
.pytest_cache/
83+
pytest_task*.txt
84+
.tddium*
85+
common/test/data/test_unicode/static/
86+
test_root/courses/
87+
test_root/data/test_bare.git/
88+
test_root/export_course_repos/
89+
test_root/paver_logs/
90+
test_root/uploads/
91+
django-pyfs
92+
.tox/
93+
common/test/db_cache/bok_choy_*.yaml
94+
common/test/data/badges/*.png
95+
96+
### Installation artifacts
97+
*.egg-info
98+
.pip_download_cache/
99+
.prereqs_cache
100+
.vagrant/
101+
node_modules
102+
bin/
103+
104+
### Static assets pipeline artifacts
105+
*.scssc
106+
lms/static/css/
107+
lms/static/certificates/css/
108+
cms/static/css/
109+
common/static/common/js/vendor/
110+
common/static/common/css/vendor/
111+
common/static/bundles
112+
webpack-stats.json
113+
114+
### Styling generated from templates
115+
lms/static/sass/*.css
116+
lms/static/sass/*.css.map
117+
lms/static/certificates/sass/*.css
118+
lms/static/themed_sass/
119+
cms/static/css/
120+
cms/static/sass/*.css
121+
cms/static/sass/*.css.map
122+
cms/static/themed_sass/
123+
themes/**/css
124+
125+
### Logging artifacts
126+
log/
127+
logs
128+
chromedriver.log
129+
ghostdriver.log
130+
131+
### Celery artifacts ###
132+
celerybeat-schedule
133+
134+
### Unknown artifacts
135+
database.sqlite
136+
courseware/static/js/mathjax/*
137+
flushdb.sh
138+
build
139+
/src/
140+
\#*\#
141+
.env/
142+
openedx/core/djangoapps/django_comment_common/comment_client/python
143+
autodeploy.properties
144+
.ws_migrations_complete
145+
dist
146+
*.bak
147+
148+
# Visual Studio Code
149+
.vscode
150+
151+
# Locally generated PII reports
152+
pii_report

.pre-commit-config.yaml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
default_language_version:
2+
# default language version for each language
3+
python: python3.8
4+
repos:
5+
- repo: https://github.com/ambv/black
6+
rev: 23.3.0
7+
hooks:
8+
- id: black
9+
- repo: https://github.com/pre-commit/pre-commit-hooks
10+
rev: v4.4.0
11+
hooks:
12+
# See https://pre-commit.com/hooks.html for more hooks
13+
- id: check-ast
14+
- id: check-case-conflict
15+
- id: check-executables-have-shebangs
16+
- id: check-merge-conflict
17+
- id: debug-statements
18+
- id: end-of-file-fixer
19+
- id: check-added-large-files
20+
args: [--maxkb=2048]
21+
- id: check-shebang-scripts-are-executable
22+
- id: check-symlinks
23+
- id: check-yaml
24+
- id: debug-statements
25+
exclude: tests/
26+
- id: destroyed-symlinks
27+
- id: end-of-file-fixer
28+
exclude: tests/test_changes/
29+
files: \.(py|sh|rst|yml|yaml)$
30+
- id: mixed-line-ending
31+
- id: trailing-whitespace
32+
files: \.(py|sh|rst|yml|yaml)$
33+
- repo: https://github.com/PyCQA/flake8
34+
rev: 6.0.0
35+
hooks:
36+
- id: flake8
37+
additional_dependencies: [
38+
'flake8-blind-except',
39+
'flake8-docstrings',
40+
'flake8-bugbear',
41+
'flake8-comprehensions',
42+
'flake8-docstrings',
43+
'flake8-implicit-str-concat',
44+
'pydocstyle',
45+
'flake8-coding',
46+
'flake8-debugger',
47+
'flake8-deprecated',
48+
'flake8-isort',
49+
'flake8-pep3101',
50+
'flake8-polyfill',
51+
'flake8-print',
52+
'flake8-quotes',
53+
'flake8-string-format',
54+
]
55+
exclude: ^tests/test_cases/no_closing_bracket\.py$
56+
- repo: https://github.com/rstcheck/rstcheck
57+
rev: v6.1.1
58+
hooks:
59+
- id: rstcheck
60+
args: [
61+
--report-level=warning,
62+
]
63+
- repo: https://github.com/codespell-project/codespell
64+
rev: v2.2.4
65+
hooks:
66+
- id: codespell
67+
files: \.(py|sh|rst|yml|yaml)$

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CHANGE LOG
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/).
7+
8+
## [0.0.1] (2023-06-28)
9+
10+
- initial release

0 commit comments

Comments
 (0)