init

Author: proquickly

.gitignore

@@ -0,0 +1,123 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+*.sublime-workspace
+
+_gsdata_/
+.pytest_cache/
+
+.DS_Store
+
+

README.md

@@ -0,0 +1,6 @@
+# 220-Advanced-Template
+## Not for class use - Fork me!
+
+This is the master repo from which an instructor will use a fork to create their class assignment repo.
+
+PLEASE do not use this for your students' assignments.

py220_grading.sublime-project

@@ -0,0 +1,22 @@
+{
+	"build_systems":
+	[
+		{
+			"file_regex": "^[ ]*File \"(...*?)\", line ([0-9]*)",
+			"name": "Anaconda Python Builder",
+			"selector": "source.python",
+			"shell_cmd": "\"/Users/andy/projects/uw/py220_grading/venv/bin/python3\" -u \"$file\""
+		}
+	],
+	"folders":
+	[
+		{
+			"follow_symlinks": true,
+			"path": "."
+		}
+	],
+	"settings":
+	{
+		"python_interpreter": "/Users/andy/projects/uw/py220_grading/venv/bin/python3"
+	}
+}

requirements.txt

@@ -0,0 +1,27 @@
+ansimarkup==1.4.0
+astroid==2.0.4
+atomicwrites==1.2.1
+attrs==18.2.0
+better-exceptions-fork==0.2.1.post6
+certifi==2018.10.15
+colorama==0.4.1
+coverage==4.5.2
+isort==4.3.4
+lazy-object-proxy==1.3.1
+loguru==0.2.5
+mccabe==0.6.1
+mock==2.0.0
+more-itertools==4.3.0
+pbr==5.1.1
+peewee==3.9.2
+pluggy==0.8.0
+py==1.7.0
+Pygments==2.3.1
+pylint==2.1.1
+pymongo==3.7.2
+pytest==4.0.0
+pytest-cov==2.6.1
+pytest-mock==1.10.0
+pytest-pylint==0.12.3
+six==1.11.0
+wrapt==1.10.11

students/README.rst

@@ -0,0 +1,15 @@
+####################
+Setting up your repo
+####################
+
+1. Create a directory for yourself here
+2. Copy the contents of the template_student directory into your new directory
+3. Be sure to copy not move!!
+4. You will then have all the lessons directories under here
+5. Back in the project parent directory, first make sure python -V shows 3.7.x
+6. If not, download and install python 3.7 and be sure it is the first python on your path
+7. Run python -m venv venv
+8. Always source venv/bin/activate (mac/Liux) or venv\Scripts\activate (windows)
+9. run pip install -r requirements.txt (you only need to do this once after install)
+10. Take a look in the sample directory to see how to run python, pytest, pylint, and coverage,
+   and how to use import in your tests and modules

students/sample/lesson01/assignment/README.md

@@ -0,0 +1,15 @@
+To place all your files where running and testing work smoothly
+
+1. All modules go in src
+2. All tests go in tests
+3. cd in to tests
+4. Run with python xxx.py
+5. Lint with pytest --pylint
+6. test with python -m pytest -vv --cov=. ../tests/
+
+Note - I like to import a module I have written with import modulename
+Then, I call a function in that module with modulename.functionname()
+
+More typing - yes (but your editor / IDE will help). Clearer - YES!
+
+See examples.

students/sample/lesson01/assignment/src/a.py

@@ -0,0 +1,17 @@
+"""
+I am test_a.py in students/yourname/lessons/lesson99/assignments/src
+run me from  students/yourname/lessons/lesson99/assignments/src
+run me with python a.py
+
+"""
+
+import b
+import c
+
+def main():
+    print("in A")
+    b.print_mess("BBBBBB")
+    c.show_mess("CCCCC")
+
+if __name__ == "__main__":
+    main()

students/sample/lesson01/assignment/src/b.py

@@ -0,0 +1,2 @@
+def print_mess(message):
+    print(message)

students/sample/lesson01/assignment/src/c.py

@@ -0,0 +1,5 @@
+def show_mess(message):
+    print(message)
+
+def missed():
+    print(0)

students/sample/lesson01/assignment/tests/test_a.py

@@ -0,0 +1,35 @@
+"""
+
+I am test_a.py in students/yourname/lessons/lesson99/assignments/tests
+run me from  students/yourname/lessons/lesson99/assignments/src
+
+
+Linting:
+pytest --pylint
+
+Test and coverage:
+python -m pytest -vv --cov=.  ../tests/
+
+
+Note my import conventions. Verbose maybe, but it makes it
+COMPLETELY CLEAR where the imported funcitonlaity comes from
+
+"""
+
+import pytest
+import a
+import b
+import c
+
+
+def test_a():
+    a.main()
+    assert 1 == 1
+
+def test_b():
+    b.print_mess("B")
+    assert 2 == 2
+
+def test_c():
+    c.show_mess("C")
+    assert 3 == 3