Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
244 commits
Select commit Hold shift + click to select a range
d913954
Added bot.env file to describe bot token.
nfoster1492 Sep 12, 2023
1626d56
Commiting changes to cog code
nfoster1492 Sep 12, 2023
3278a7a
added bot.env to gitignore
nfoster1492 Sep 12, 2023
e1cbda7
updated .gitignore
nfoster1492 Sep 12, 2023
6c4c040
removed bot.env
nfoster1492 Sep 12, 2023
bd9c964
Updated to async functions
Sep 26, 2023
669cfe4
Merge branch 'main' of https://github.com/nfoster1492/ClassMateBot-1 …
Sep 26, 2023
3596009
Updated the init.sql file to include new tables
Sep 28, 2023
cec60cb
Set up cog file, refactored deadline
Sep 28, 2023
31a9efe
feat: Allowed for bot to access Google Calendar API (Issue #2)
Sep 29, 2023
d993c9f
feat: add event to calendar via command (Issue #2)
Oct 2, 2023
d295df0
Add/Edit/Delete/View grading categories and weights
Oct 3, 2023
a457309
Added grade command and fixed typo in SQL
nfoster1492 Oct 3, 2023
2d30929
Added function for getting grades by category
nfoster1492 Oct 3, 2023
3fa817f
added ability to create/edit/remove an assignment
Oct 3, 2023
e03539d
Added function for getting the required next grade
nfoster1492 Oct 4, 2023
2b0bde4
Added ability to add grades
Oct 5, 2023
3765331
Merge branch 'grading' of https://github.com/nfoster1492/ClassMateBot…
Oct 5, 2023
ddc8a70
Added documentation
Oct 5, 2023
7f15e1d
ran the linter and fixed style errors
Oct 6, 2023
49f770a
Merge pull request #18 from nfoster1492/grading
nfoster1492 Oct 6, 2023
d5fad0f
Fixed grade methods for students
nfoster1492 Oct 6, 2023
a3bba5e
feat: added command to get an ics file of the calendar (Issue #1)
Oct 7, 2023
a09ef1d
fix: made path for ics to be pulled from .env (Issue #1)
Oct 7, 2023
0d708fe
feat: added command to send pdf file of calendar (Issue #4)
Oct 7, 2023
63f18b2
feat: Added check each day for due dates (Issue #6)
Oct 7, 2023
8169aa6
Fixed async testing issue
Oct 7, 2023
8c200ac
Added functions for professors grade reports
Oct 8, 2023
283873e
fix: changed the assert statements in test_deadline (Issue #19)
Oct 8, 2023
ac798ed
fix: made test_listreminders passing (Issue #20)
Oct 8, 2023
09f6aa1
fix: updated duethisweek and duetoday to pass
Oct 8, 2023
4d5281b
Update installation.md
brwali Oct 8, 2023
4845a00
Update installation.md to include Google Calendar information
brwali Oct 8, 2023
9d03af2
Updated class website in welcome message
nathankohen Oct 9, 2023
62b5eb6
New features to add and remove calendar subscribers
nathankohen Oct 9, 2023
69673be
Added documentation for calendar functions I worked on
Oct 9, 2023
a47d9f1
Update README.md
rpkenney Oct 9, 2023
7edb4ae
Update README.md
rpkenney Oct 9, 2023
e2a0dbc
resolved some pylint errors
Oct 9, 2023
6a77abc
disabling no member pylint feature
Oct 9, 2023
096fd79
Added black github action as code formatter
Oct 9, 2023
b15f4b4
Merge branch 'main' of https://github.com/nfoster1492/ClassMateBot-1 …
Oct 9, 2023
5ff086c
Update README.md
rpkenney Oct 9, 2023
b65643b
updated github actions with correct python version
Oct 9, 2023
1d2f2b1
#23 resolved failing test case
rpkenney Oct 9, 2023
b7cc8b3
update module version
rpkenney Oct 9, 2023
9bcfdfd
update psycopg2-binary version
rpkenney Oct 9, 2023
b7eee4d
updated module versions
rpkenney Oct 9, 2023
f17284d
cleaning the pylint config file of useless disables
Oct 9, 2023
5962135
fix: adjusted calendar.py to match pylint rules
Oct 10, 2023
c3a93f6
reformatting files with black code formatter
Oct 10, 2023
c01a68a
more files that were reformatted with black
Oct 10, 2023
5d063aa
Added documentation to written grades commands
nfoster1492 Oct 11, 2023
5219630
Update main.yml
nfoster1492 Oct 11, 2023
27375ad
Added a grade required command
nfoster1492 Oct 11, 2023
323806e
Merge branch 'main' of https://github.com/nfoster1492/ClassMateBot-1
nfoster1492 Oct 11, 2023
f5a0c09
Added final student commands in grades.py
nfoster1492 Oct 12, 2023
5775baa
chore: Added tests to test commands in assignments.py
Oct 14, 2023
9b84dff
Update README.md
brwali Oct 15, 2023
ca914c4
Updated Installation Guide Link
nathankohen Oct 15, 2023
726b916
removed awaits load_extensions
rpkenney Oct 15, 2023
6dda427
Update README.md
rpkenney Oct 15, 2023
aa10cb4
Update README.md
nathankohen Oct 15, 2023
d4cdfc1
Update requirements.txt
rpkenney Oct 15, 2023
0bc4d98
Updated requirements.txt
Oct 15, 2023
1f04f58
fixed pylint and black errors
Oct 15, 2023
f1ddd69
Update README.md
nfoster1492 Oct 15, 2023
c9f3b8a
changed links in readme
rpkenney Oct 15, 2023
fd4440f
Update README.md
nfoster1492 Oct 15, 2023
fc5aeb4
Update README.md
nfoster1492 Oct 15, 2023
8d2e84b
Update installation.md
brwali Oct 15, 2023
dcfc1b2
Update installation.md
brwali Oct 15, 2023
e5c8f73
Update README.md
rpkenney Oct 15, 2023
72cbe07
calendar integration with duedate
nathankohen Oct 15, 2023
3db3f8b
Merge branch 'main' of https://github.com/nfoster1492/ClassMateBot-1
nathankohen Oct 15, 2023
49d72dc
fix: fixed addassignment and editassignment failing test (Issue #24)
Oct 15, 2023
2d6ff36
removed unused imports
rpkenney Oct 15, 2023
1bd7d0f
chore: adding documentation files for calendar commands
Oct 16, 2023
95fcdfd
Update getPdfDownload.md
brwali Oct 16, 2023
c5f0320
Update getPdfDownload.md
brwali Oct 16, 2023
26a4af8
Update getPdfDownload.md
brwali Oct 16, 2023
71429c9
Update getiCalDownload.md
brwali Oct 16, 2023
d52c6da
Update README.md
brwali Oct 16, 2023
7ba64db
changing variable names in calendar task to improve readability
Oct 16, 2023
9b06658
updated documentation
rpkenney Oct 17, 2023
ca8e5e9
Update categories.md
rpkenney Oct 17, 2023
176242d
Update categories.md
rpkenney Oct 17, 2023
eb75dd6
Update categories.md
rpkenney Oct 17, 2023
30e1ab4
documented input_grades
rpkenney Oct 17, 2023
e75887d
documentation for grades.py
rpkenney Oct 17, 2023
b02c10b
docs for assignments
rpkenney Oct 17, 2023
aa9538e
Updated README.md
rpkenney Oct 17, 2023
bc320f3
Update README.md
rpkenney Oct 17, 2023
92a6a2b
Create grade.md
nfoster1492 Oct 17, 2023
14dd0f9
Update grade.md
nfoster1492 Oct 17, 2023
c8e9fda
Add files via upload
nfoster1492 Oct 17, 2023
4215b3b
Update grade.md
nfoster1492 Oct 17, 2023
0d63b58
Create gradebycategory.md
nfoster1492 Oct 17, 2023
107aa21
Update gradebycategory.md
nfoster1492 Oct 17, 2023
1453b81
Add files via upload
nfoster1492 Oct 17, 2023
03a9cf5
Update gradebycategory.md
nfoster1492 Oct 17, 2023
8676475
Create gradeforclass.md
nfoster1492 Oct 17, 2023
fb759f2
Update gradeforclass.md
nfoster1492 Oct 17, 2023
4de2e3a
Add files via upload
nfoster1492 Oct 17, 2023
abf195f
Update gradeforclass.md
nfoster1492 Oct 17, 2023
4ab2f98
Create graderequired
nfoster1492 Oct 17, 2023
fbb1811
Update and rename graderequired to graderequired.md
nfoster1492 Oct 17, 2023
29991bb
Create graderequiredforclass.md
nfoster1492 Oct 17, 2023
80d3e55
Update graderequiredforclass.md
nfoster1492 Oct 17, 2023
bac5ce2
Added help documentation to calendar function
nfoster1492 Oct 17, 2023
87e9e35
Added documentation files for calendar functions
nathankohen Oct 17, 2023
cfec1b8
Fixed where the output was sent for cal commands
nfoster1492 Oct 17, 2023
fdfd913
Changes to calendar.py and added failing tests
nfoster1492 Oct 17, 2023
e436cde
Update removeCalendar.md
nathankohen Oct 17, 2023
a66baeb
Small change to grade command
nfoster1492 Oct 17, 2023
fc9ff95
Black formatting
nfoster1492 Oct 17, 2023
cc414bb
Update subscribeCalendar.md
nathankohen Oct 17, 2023
cf0647a
Updated installation.md with calendar token soln
nathankohen Oct 17, 2023
df203d8
Update README.md
brwali Oct 17, 2023
e0f2145
Reorganization of previous team documentation
nathankohen Oct 17, 2023
31de086
Merge branch 'main' of https://github.com/nfoster1492/ClassMateBot-1
nathankohen Oct 17, 2023
309141e
Added proj2 contribution and rubric - s23
nathankohen Oct 17, 2023
b318564
Update proj2rubric.md
nathankohen Oct 17, 2023
873dd52
Update Project2Changes.md
nathankohen Oct 17, 2023
0487358
added tests for pdf and ical
rpkenney Oct 17, 2023
4914969
Merge branch 'main' of https://github.com/nfoster1492/ClassMateBot-1 …
rpkenney Oct 17, 2023
d9fdc23
Update README.md
brwali Oct 17, 2023
4d7df2e
testing credentials issue
rpkenney Oct 17, 2023
9e3beb5
Merge branch 'main' of https://github.com/nfoster1492/ClassMateBot-1 …
rpkenney Oct 17, 2023
0e7f294
Add files via upload
nfoster1492 Oct 17, 2023
e5dd57c
removed credentials env
rpkenney Oct 17, 2023
9feffd4
Merge branch 'main' of https://github.com/nfoster1492/ClassMateBot-1 …
rpkenney Oct 17, 2023
1e1b882
fixed calendar test
nfoster1492 Oct 17, 2023
469adb7
Update README.md
nfoster1492 Oct 17, 2023
1cee716
Update README.md
nfoster1492 Oct 17, 2023
8281501
Update README.md
nfoster1492 Oct 17, 2023
ca300dd
Update CONTRIBUTING.md
nfoster1492 Oct 17, 2023
8e59c44
Update CONTRIBUTING.md
nfoster1492 Oct 17, 2023
b4bac64
Update CONTRIBUTING.md
nfoster1492 Oct 17, 2023
9e5b412
Refactoring discord task to reduce code
Oct 17, 2023
eef4906
Create CHAT.md
nfoster1492 Oct 17, 2023
9331d14
Update CHAT.md
nfoster1492 Oct 17, 2023
b27a918
Add files via upload
nfoster1492 Oct 17, 2023
abb7aae
Update CHAT.md
nfoster1492 Oct 17, 2023
9255e0e
Update CHAT.md
nfoster1492 Oct 17, 2023
149321e
Update README.md
nfoster1492 Oct 17, 2023
ba4166a
resolved local test failures
rpkenney Oct 17, 2023
7a6d6c6
Merge branch 'main' of https://github.com/nfoster1492/ClassMateBot-1 …
rpkenney Oct 17, 2023
0b05d86
Update pytest.yml
rpkenney Oct 17, 2023
a3d488a
Update pytest.yml
rpkenney Oct 17, 2023
cb18180
Update pytest.yml
rpkenney Oct 17, 2023
bb88f8e
Update pytest.yml
rpkenney Oct 17, 2023
6ca99d0
Added ability for CI to access files
rpkenney Oct 18, 2023
83cb758
Merge branch 'main' of https://github.com/nfoster1492/ClassMateBot-1 …
rpkenney Oct 18, 2023
8d33c18
updated test for grades
Oct 18, 2023
5050fd8
attempt to resolve failing test case
rpkenney Oct 18, 2023
74fd51f
Merge branch 'main' of https://github.com/nfoster1492/ClassMateBot-1 …
rpkenney Oct 18, 2023
3c92f86
comment out failing test case
rpkenney Oct 18, 2023
2377b27
Changes to grades.py
nfoster1492 Oct 18, 2023
0236aff
Merge pull request #29 from nfoster1492/gradesChanges
nfoster1492 Oct 18, 2023
7514a51
Added docscript for functions
nathankohen Oct 18, 2023
875b075
Update pytest.yml
rpkenney Oct 18, 2023
efbab68
Update token.json
rpkenney Oct 18, 2023
2d111c0
edit test/data
rpkenney Oct 18, 2023
f625b45
Merge branch 'main' of https://github.com/nfoster1492/ClassMateBot-1 …
rpkenney Oct 18, 2023
7b03912
Update pytest.yml
rpkenney Oct 18, 2023
4da17cf
resolved breaking change in inputgrades
rpkenney Oct 18, 2023
99c1eea
Added some docscripts for grades
nathankohen Oct 18, 2023
d4328e0
Docscript added for grades and groups
nathankohen Oct 18, 2023
8c2677a
Docscript for newcomer and ping added
nathankohen Oct 18, 2023
40ac1db
Docscript pinning polling QandA
nathankohen Oct 18, 2023
06c27cb
Docscript for reviewQs voting wordfilter
nathankohen Oct 18, 2023
c69178c
Auto-generated documentation
nathankohen Oct 18, 2023
fd73615
updated testing on grades.py
Oct 18, 2023
0534526
float string formatting
rpkenney Oct 18, 2023
7d399a6
Update LICENSE
brwali Oct 18, 2023
e65d8f7
Update LICENSE
brwali Oct 18, 2023
6b20ad9
Create Dependencies.md
brwali Oct 18, 2023
12b98db
Added error handling to grades.py commands
nfoster1492 Oct 18, 2023
35fed30
added copyright headers for new files that were created
Oct 18, 2023
c436655
Update README.md
rpkenney Oct 18, 2023
845c2f5
Update README.md
rpkenney Oct 18, 2023
08712dc
fixed pylint errors
Oct 19, 2023
6b0f39d
updated lynt config file
Oct 19, 2023
26f2c3a
attempt to fix calendar test failure
rpkenney Oct 19, 2023
a6003e5
resolved failing test cases
rpkenney Oct 19, 2023
eeb2020
resolved error in test_get_calendar_downloads
rpkenney Oct 19, 2023
993564a
Update Dependencies.md
brwali Oct 19, 2023
33331c5
pushing grade test changes
Oct 19, 2023
b602f6e
Update README.md
nfoster1492 Oct 19, 2023
67a96a7
Update README.md
nfoster1492 Oct 19, 2023
d6b77e4
Update README.md
nfoster1492 Oct 19, 2023
7422032
Update README.md
nfoster1492 Oct 19, 2023
1d7ede0
Update README.md
nfoster1492 Oct 19, 2023
a862cf3
resolved error in calendar_downloads
rpkenney Oct 19, 2023
ab94f4a
attempt to resolve calendar bug
rpkenney Oct 19, 2023
c9d9841
Update main.yml
rpkenney Oct 19, 2023
de7eb5d
Update main.yml
rpkenney Oct 19, 2023
2dcc173
update docs
rpkenney Oct 19, 2023
37fc39e
resolve calendar error
rpkenney Oct 19, 2023
d870272
Instructor grades tests
nathankohen Oct 19, 2023
324943d
Commented out failed assertion
nathankohen Oct 19, 2023
a58b815
Added troubleshoot documentation
nathankohen Oct 19, 2023
9ff84c3
Added additional student tests for grade.py
Oct 19, 2023
c033652
added first gif
rpkenney Oct 19, 2023
70cae1c
Update README.md
rpkenney Oct 19, 2023
da28d9d
Update Dependencies.md
brwali Oct 19, 2023
da15618
Update troubleshoot.md
brwali Oct 19, 2023
ec3a82a
Error tests for instructor grades
nathankohen Oct 19, 2023
07a904e
Merge branch 'main' of https://github.com/nfoster1492/ClassMateBot-1
nathankohen Oct 19, 2023
dfec051
Create README.md
brwali Oct 19, 2023
0288c42
Update README.md
brwali Oct 19, 2023
501d38c
Add rest of gifs
rpkenney Oct 19, 2023
a95187d
Update README.md
rpkenney Oct 19, 2023
c0979fb
Update README.md
rpkenney Oct 19, 2023
2b55e2c
Update README.md
rpkenney Oct 19, 2023
f5af524
sped up gif speed
rpkenney Oct 19, 2023
0a51da8
Update calendar documentation labels README.md
nathankohen Oct 19, 2023
7ed0f9f
addCalendarEvent documentation
nathankohen Oct 19, 2023
a97322e
Update README.md
nathankohen Oct 19, 2023
eb84701
Added troubleshooting link in README
nathankohen Oct 19, 2023
4e4ac8a
Update addCalendarEvent.md
nathankohen Oct 19, 2023
407ec25
Update addCalendarEvent.md
nathankohen Oct 19, 2023
b3bc346
Update clearCalendar.md
nathankohen Oct 19, 2023
197e526
Pics for subscribeCalendar documentation
nathankohen Oct 19, 2023
ba815bd
Update subscribeCalendar.md
nathankohen Oct 19, 2023
981047f
Update removeCalendar.md
nathankohen Oct 19, 2023
6f162b4
Update README.md
nathankohen Oct 19, 2023
c81639d
update rubric
rpkenney Oct 19, 2023
b59d557
update rubric
rpkenney Oct 19, 2023
0244a23
Update README.md
rpkenney Oct 19, 2023
68ca569
Update README.md
rpkenney Oct 19, 2023
494a60b
Update Dependencies.md
rpkenney Oct 19, 2023
a1331db
Update README.md
nfoster1492 Oct 19, 2023
6842fe4
Update README.md
nfoster1492 Oct 19, 2023
7ae7560
Update README.md
nfoster1492 Oct 19, 2023
2fcfc3c
Update README.md
nfoster1492 Oct 19, 2023
6684470
Update CITATION.md
brwali Oct 19, 2023
12ac231
Update README.md
brwali Oct 19, 2023
8f90ce4
Documentation reorganization
nathankohen Oct 19, 2023
9758d63
Update Project2Changes.md
nathankohen Oct 19, 2023
512987b
Update README.md
nathankohen Oct 19, 2023
56f5d62
Update README.md
nfoster1492 Oct 20, 2023
742b43c
Update README.md with sum
nathankohen Oct 20, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/workflows/black.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Black

on: [push, pull_request]

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: psf/black@stable
2 changes: 1 addition & 1 deletion .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ name: "CodeQL"

on:
push:
branches: [ main, group25-cloud-deployment ]
branches: [ main]
pull_request:
# The branches below must be a subset of the branches above
branches: [ main ]
Expand Down
20 changes: 12 additions & 8 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,15 @@ jobs:

steps:
- uses: actions/checkout@v2
- name: Set up Python 3.9
- name: Set up Python 3.11
uses: actions/setup-python@v2
with:
python-version: 3.9
python-version: 3.11
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pylint
sudo apt-get install xvfb libfontconfig wkhtmltopdf
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: Lint with pylint
run: |
Expand All @@ -28,12 +29,15 @@ jobs:
run: |
cat << EOF > .env
DATABASE_URL=${{ secrets.DATABASE_URL }}
CALENDAR_ID=${{ secrets.CALENDAR_ID }}
CALENDAR_PATH=${{ secrets.CALENDAR_PATH }}
CALENDAR_ICS=${{ secrets.CALENDAR_ICS }}
EOF
- name: Test with pytest
run: pytest
run: pytest --tb=line
- name: Generate coverage
run: pytest --cov-config=.coveragerc --cov --cov-report=xml
- name: "Upload coverage to Codecov"
uses: codecov/codecov-action@v2
with:
fail_ci_if_error: true
run: pytest --tb=line --cov-config=.coveragerc --cov --cov-report=xml
- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v3
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
4 changes: 2 additions & 2 deletions .github/workflows/pylint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ jobs:

steps:
- uses: actions/checkout@v2
- name: Set up Python 3.9
- name: Set up Python 3.11
uses: actions/setup-python@v2
with:
python-version: 3.9
python-version: 3.11
- name: Install dependencies
run: |
python -m pip install --upgrade pip
Expand Down
11 changes: 8 additions & 3 deletions .github/workflows/pytest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,24 @@ jobs:

steps:
- uses: actions/checkout@v2
- name: Set up Python 3.9
- name: Set up Python 3.11
uses: actions/setup-python@v2
with:
python-version: 3.9
python-version: 3.11
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pylint
sudo apt-get install xvfb libfontconfig wkhtmltopdf
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: Create env file
run: |
cat << EOF > .env
TOKEN=${{ secrets.TOKEN }}
DATABASE_URL=${{ secrets.DATABASE_URL }}
CALENDAR_ID=${{ secrets.CALENDAR_ID }}
CALENDAR_PATH=${{ secrets.CALENDAR_PATH }}
CALENDAR_ICS=${{ secrets.CALENDAR_ICS }}
EOF
- name: Test with pytest
run: pytest
run: pytest --tb=line
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -127,3 +127,14 @@ dmypy.json

# Pyre type checker
.pyre/
bot.env
bot.env

#Google calendar stuff
credentials.json
token.json
ical.ics
calendar.pdf
dpytest_0.dat
!/test/data/calendar.pdf
!/test/data/ical.ics
83 changes: 8 additions & 75 deletions .pylintrc
Original file line number Diff line number Diff line change
Expand Up @@ -74,85 +74,18 @@ confidence=
# --enable=similarities". If you want to run only the classes checker, but have
# no Warning level messages displayed, use "--disable=all --enable=classes
# --disable=W".
disable=print-statement,
parameter-unpacking,
unpacking-in-except,
old-raise-syntax,
backtick,
long-suffix,
old-ne-operator,
old-octal-literal,
import-star-module-level,
non-ascii-bytes-literal,
raw-checker-failed,
disable=raw-checker-failed,
bad-inline-option,
locally-disabled,
file-ignored,
suppressed-message,
useless-suppression,
consider-using-enumerate,
undefined-loop-variable,
unused-variable,
deprecated-pragma,
use-symbolic-message-instead,
apply-builtin,
basestring-builtin,
buffer-builtin,
cmp-builtin,
coerce-builtin,
execfile-builtin,
file-builtin,
long-builtin,
raw_input-builtin,
reduce-builtin,
standarderror-builtin,
unicode-builtin,
xrange-builtin,
coerce-method,
delslice-method,
getslice-method,
setslice-method,
no-absolute-import,
old-division,
dict-iter-method,
dict-view-method,
next-method-called,
metaclass-assignment,
indexing-exception,
raising-string,
reload-builtin,
oct-method,
hex-method,
nonzero-method,
cmp-method,
input-builtin,
round-builtin,
intern-builtin,
unichr-builtin,
map-builtin-not-iterating,
zip-builtin-not-iterating,
range-builtin-not-iterating,
filter-builtin-not-iterating,
using-cmp-argument,
eq-without-hash,
div-method,
idiv-method,
rdiv-method,
exception-message-attribute,
invalid-str-codec,
sys-max-int,
bad-python3-import,
deprecated-string-function,
deprecated-str-translate-call,
deprecated-itertools-function,
deprecated-types-field,
next-method-defined,
dict-items-not-iterating,
dict-keys-not-iterating,
dict-values-not-iterating,
deprecated-operator-function,
deprecated-urllib-function,
xreadlines-attribute,
deprecated-sys-function,
exception-escape,
comprehension-escape,
no-member,
C0114, # Missing module docstring (missing-module-docstring)
C0115,
C0116,
Expand All @@ -167,10 +100,10 @@ disable=print-statement,
R0915, # Too many statements (85/50) (too-many-statements)
R0903, # Too few public methods (0/2) (too-few-public-methods)
R0904, # Too many public methods (24/20) (too-many-public-methods)
R1732,
E0401,
C0413,
R0801,
R0201,
C0301, # Line too long (127/120) (line-too-long)
C0411, # (wrong-import-order)
W0611, # Unused join imported from os.path (unused-import)
Expand Down Expand Up @@ -647,5 +580,5 @@ min-public-methods=2

# Exceptions that will emit a warning when being caught. Defaults to
# "BaseException, Exception".
overgeneral-exceptions=BaseException,
Exception
overgeneral-exceptions=builtins.BaseException,
builtins.Exception
9 changes: 9 additions & 0 deletions CHAT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# ClassMateBot Developers Chat

<img src="https://github.com/nfoster1492/ClassMateBot-1/blob/abb7aae913c38776c7307447a705ef2697d3b3d9/data/proj2media/discordScreenshot.png" width="1000">
This is a screenshot of what our developers' communication channel looks like.

## Means of Communication

As a team, we used Discord voice channels and text channels to communicate about ClassMateBot.
We used ClassMateBot in this channel to test its functionality locally.
16 changes: 16 additions & 0 deletions CITATION.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
Cite as

Brandon Walia, Nicholas Foster, Robert Kenney, Nathan Kohen. (2023, October 19). nfoster1492/ClassMateBot-1 (Version v4).
Zenodo. https://doi.org/10.5281/zenodo.5673334

```
@software{nfoster1492/ClassMateBot-1,
title = {nfoster1492/ClassMateBot-1 (Version v4)},
DOI = {10.5281/zenodo.10023404},
author = {Brandon Walia, Nicholas Foster, Robert Kenney, Nathan Kohen},
publisher = {Zenodo},
year = {2023},
month = {October}
}
```

For Version 3 Cite as

Emily Tracey, Leila Moran, Shraddha Mishra, Jonathan Nguyen, & Peeyush Taneja. (2021, November 10). CSC510-Group-25/ClassMateBot (Version v3).
Zenodo. https://doi.org/10.5281/zenodo.5673334

Expand Down
38 changes: 23 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The following is a set of guidelines for contributing to ClassMate Bot. These

[Code of Conduct](#code-of-conduct)

[I don't want to read this whole thing, I just have a question!!!](#i-dont-want-to-read-this-whole-thing-i-just-have-a-question)
[Quick Support](#quick-support)

[How Can I Contribute?](#how-can-i-contribute)
* [Pull Requests](#pull-requests)
Expand All @@ -19,44 +19,46 @@ The following is a set of guidelines for contributing to ClassMate Bot. These
* [Git Commit Messages](#git-commit-messages)
* [Python Style Guide](#python-style-guide)

[Governal Policies](#governal-policies)

## Code of Conduct

This project and everyone participating in it is governed by the [ClassMate Bot Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to any of the original team members listed at the bottom of [README.md](README.md).

## I don't want to read this whole thing I just have a question!!!
## Quick Support

Reach out to one of the main contributors on Discord using their IDs:
* Emily Tracey: etracey@ncsu.edu
* Jonathan Nguyen: jhnguye4@ncsu.edu
* Leila Moran: lmmoran@ncsu.edu
* Peeysh Taneja: ptaneja@ncsu.edu
* Shraddha Mishra: smishra9@ncsu.edu
Support Email:
* *classmatebot5@gmail.com*

*Note: Due to the dynamic nature of Discord IDs, these may change without prior notice on this page.*
Reach out to one of the main contributors:
* Robert Kenney: *rpkenney@ncsu.edu*
* Brandon Walia: *bswalia@ncsu.edu*
* Nathan Kohen: *nrkohen@ncsu.edu*
* Nicholas Foster: *nsfoster@ncsu.edu*

We do not have an official message board at this time, however, we plan to have one if it will help future contributors!
We would love to help with whatever issues you have or questions about contributing to ClassMateBot!

## How Can I Contribute?

### Pull Requests

The process described here has several goals:

- Maintain the projects quality
- Maintain the project's quality

- Fix problems that are important to users

- Enable a sustainable system for the projects maintainers to review contributions
- Enable a sustainable system for the projects maintainers' to review contributions

Please follow these steps to have your contribution reviewed by the maintainers:

1. Include a clear and descriptive title.
2. Include a description of the change.
2. Include a detailed description of the change.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

### Adding Commands
Commands can be added in the form of Cogs. View hello.py as a simple example of how a Cog can be added.
Commands can be added in the form of Cogs. View hello.py as a simple example of how a Cog can be added.

The basic structure is as follows:

Expand All @@ -75,7 +77,7 @@ For more information on how to use cogs, refer to the [Cogs Page](https://discor

For more information on the API of discord.py you can use the [API Reference Page](https://discordpy.readthedocs.io/en/stable/api.html)

For general Knowledge of discord.py use the [Documentation Page](https://discordpy.readthedocs.io/en/latest/index.html)
For general knowledge of discord.py use the [Documentation Page](https://discordpy.readthedocs.io/en/latest/index.html)
## Reporting Bugs

This section guides you through submitting a bug report for ClassMateBot.
Expand Down Expand Up @@ -118,4 +120,10 @@ Changes to ClassMateBot Python code should conform to [Google Python Style Guide
All Python code is linted with Pylint. Ensure that before you commit any changes, your code passes all default pylint checks. Pylint can be installed with
`pip install pylint`.

All Python code is formatted using Black. Ensure that before you commit any changes, you run Black on all updated files and ensure that the code passes the Black checks.

### Governal Policies

All contributions will be carefully reviewed by our entire development team. We will discuss the advantages and disadvantages of adding the change, and a final decision will be decided based on a vote, with all members' votes having equal weight.

*This document is adapted from the [Atom Code of Conduct](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#code-of-conduct)*
33 changes: 33 additions & 0 deletions Dependencies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
All libraries used with their licenses and links to repo. all are mandatory
| Library | License | Link to Source|
-----------|--------|---------------|
aiohttp| Apache| https://github.com/aio-libs/aiohttp
async-timeout| Apache| https://github.com/aio-libs/async-timeout
attrs| MIT| https://github.com/python-attrs/attrs
black| MIT |https://github.com/psf/black
coverage| MIT |https://github.com/sueastside/python-coverage
coverage-badge |MIT |https://github.com/tj-actions/coverage-badge-py
discord| MIT| https://github.com/Rapptz/discord.py
discord.py |MIT| https://github.com/Rapptz/discord.py
dpytest| MIT| https://github.com/CraftSpider/dpytest
jishaku| MIT| https://github.com/Gorialis/jishaku
packaging| Apache| https://github.com/pypa/packaging
py |GPL-compatible| www.python.org
pdfkit |MIT |https://github.com/foliojs/pdfkit
pytest |MIT |https://github.com/pytest-dev/pytest
pytest-asynico |Apache| https://github.com/pytest-dev/pytest-asyncio
pytest-cov |MIT| https://github.com/pytest-dev/pytest-cov
python-dateutil |Apache| https://github.com/dateutil/dateutil
python-dotenv| BSD-3-Clause "New" or "Revised"| https://github.com/theskumar/python-dotenv
psycopg2-binar| LGPL| https://github.com/psycopg/psycopg2
better-profanity |MIT| https://github.com/snguyenthanh/better_profanity
requests| Apache| https://github.com/psf/requests
pandas| BSD-3-Clause |https://github.com/pandas-dev/pandas
google-api-core |Apache |https://github.com/googleapis/python-api-core
google-api-python-client |Apache| https://github.com/googleapis/google-api-python-client
google-auth| Apache| https://github.com/googleapis/google-auth-library-python
google-auth-httplib2| Apache| https://github.com/googleapis/google-auth-library-python-httplib2
google-auth-oauthlib |Apache| https://github.com/googleapis/google-auth-library-python-oauthlib
googleapis-common-protos| Apache |https://github.com/googleapis/api-common-protos
PyPDF2| BSD Clause| https://github.com/py-pdf/pypdf
vobject |Apache| https://github.com/eventable/vobject
4 changes: 4 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@ MIT License

Copyright (c) 2021 SE21-Team2

Copyright for portions of project ClassMateBot-1 are held by SE21-Team2,2021
as part of project ClassMateBot. All other copyright for project ClassMateBot-1
are held by nfoster1492, 2023.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
Expand Down
Loading