No description, website, or topics provided.
Clone or download
jeffboykin and GitHub Enterprise Update README.md
new title
Latest commit 226497b Dec 7, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
tests Update README.md Dec 7, 2018
README.md Update README.md Dec 7, 2018
requirements.txt Initial commit Dec 3, 2018

README.md

Enhanced Python “Installfest”

Using Package Installers and Test Scripts

  • Question: Can we use Python to help learners prepare for Python?
  • Answer: Yes, we can!

Authors: Jeff Boykin, Sonyl Nagale

Premise

Manual "installfest" sessions can be a lengthy process for students and instructors. Unique hardware configurations, permissions issues, and lack of clear requirements can all cause problems.

We can't fix all of those things... but we can fix one of them!

By (a) defining clear tech requirements and (b) providing a test that confirms confirms student hardware against those requirements, while (c) flagging problems in an intuitive manner, we can make installfest dramatically more efficient for students and instructors alike.

Relevant Files

  • requirements.txt - currently configured for Python PT course materials
  • config.ini - currently configured for Python PT course materials
    • Note: These two items must be kept up to date and should list the same package versions in order to ensure that tests and installations run successfully.

Execution

  1. Students should first complete local Python set up as a prerequisite step. Instructions for this can be found here.
  2. Once local Python is installed, students should install Virtualenv to create a pythonic sandbox. Open a new terminal window and run the following command: pip install virtualenv.
  3. Create a directory for coursework, e.g. mkdir python.
  4. Navigate into that directory: cd python.
  5. Set up a virtual environment in that directory: virtualenv python_course.
  6. Activate the virtual environment: source python_course/bin/activate.
    • From this point forward, students are in a virtual environment!.
    • Working in this environment during the course is more stable for students.
    • N.b. time will have to be allotted for starting and stopping environments.
  7. Run the test script: cd tests; python test_package_versions.py.
  8. Run the installation: cd ..; pip install -r requirements.txt.
  9. Re-run the test script to ensure package cohesion.