Merge branch 'namespaced' of git://tremily.us/swc-version-control-git into assembled

Merge branch 'namespaced' of git://tremily.us/swc-version-control into assembled

Merge remote tracking branch 'version-control-svn/namespaced' into namespaced

This is a no-op merge, explicitly considering and rejecting the
removal of subject-level documents from this subject-level branch.
After this merge, folks can merge both version-control/namespaced and
version-control-svn/namespaced branches without conflicts.

* version-control-svn/namespaced:
  version-control: Remove subject-level documents from this SVN branch

Merge branch 'master' into namespaced

This is a no-op merge, explicitly considering and rejecting the
de-namespacing from the master branch.  After this merge, future
merges from the master branch will pick up any content changes.

  $ git merge --log --no-ff --strategy ours master

* master:
  README.md: Remove nesting version-control/git

Merge branch 'namespaced' of git://tremily.us/swc-setup-installation-test into assembled

Merge branch 'namespaced' of git://tremily.us/swc-setup-windows-installer into assembled

Merge branch 'namespaced' of git://tremily.us/swc-setup-get-my-ip into assembled

Merge branch 'namespaced' of git://tremily.us/swc-setup into assembled

Merge branch 'master' into assembled

This is a no-op merge, explicitly considering and rejecting the
submodules from the master branch.  After this merge, future merges
from the master branch will pick up any content changes.

  $ git merge --log --no-ff --strategy ours master

* master:
  setup: Add a submodule with student-setup utilities
  version-control: Add a submodule with my subject-level notes

README.md: Add nesting setup/installation-test/

Mimic the path that submodule users will have.

swc-windows-installer.py: Add nesting setup/windows-installer/

Mimic the path that submodule users will have.

get-my-ip.py: Add nesting setup/get-my-ip/

Mimic the path that submodule users will have.

setup: Add a submodule with student-setup utilities

Merge branch 'master' into namespaced

This is a no-op merge, explicitly considering and rejecting the
submodules from the master branch.  After this merge, future merges
from the master branch will pick up any content changes.

* master:
  installation-test: Add a submodule with my installation test scripts
  windows-installer: Add a submodule with Ethan's Windows installer
  get-my-ip: Add a submodule with my IP detection script

README.md: Add nesting setup/

This gives the submodule-averse the nesting they'd usually get by
merging the master branch in a submodule at setup/.  They'll have to
merge the submodule's 'namespaced' branches by hand to pull in the
equivalent content.

installation-test: Add a submodule with my installation test scripts

windows-installer: Add a submodule with Ethan's Windows installer

get-my-ip: Add a submodule with my IP detection script

Merge branch 'master' into namespaced

This is a no-op merge, explicitly considering and rejecting the
de-namespacing from the master branch.  After this merge, future
merges from the master branch will pick up any content changes.

  $ git merge --log --no-ff --strategy ours master

* master:
  README.md: Remove nesting setup/

README.md: Remove nesting setup/

There's no need to hard-code target directories in this repository.
Anyone consuming this material can use submodules and pick their own
target directory.

README: Summarize the purpose of this repository

Merge branch 'master' into namespaced

This is a no-op merge, explicitly considering and rejecting the
de-namespacing from the master branch.  After this merge, future
merges from the master branch will pick up any content changes.

  $ git merge --log --no-ff --strategy ours master

* master:
  swc-windows-installer.py: Remove nesting setup/

swc-windows-installer.py: Remove nesting setup/

There's no need to hard-code target directories in this repository.
Anyone consuming this material can use submodules and pick their own
target directory.

Merge branch 'master' into namespaced

This is a no-op merge, explicitly considering and rejecting the
de-namespacing from the master branch.  After this merge, future
merges from the master branch will pick up any content changes.

  $ git merge --log --no-ff --strategy ours master

* master:
  get-my-ip.py: Remove nesting setup/

get-my-ip.py: Remove nesting setup/

There's no need to hard-code target directories in this repository.
Anyone consuming this material can use submodules and pick their own
target directory.

Merge branch 'master' into namespaced

This is a no-op merge, explicitly considering and rejecting the
de-namespacing and submodule addition from the master branch.  After
this merge, future merges from the master branch will pick up any
content changes.  Until the next submodule addition anyway, then we'll
need another no-op merge to reject that.

* master:
  svn: Add a submodule with my Subversion notes
  git: Add a submodule with my Git notes
  README.md: Remove nesting version-control/

version-control: Add a submodule with my subject-level notes

svn: Add a submodule with my Subversion notes

git: Add a submodule with my Git notes

I'm using tremily.us hosting while I stub this out, because setting up
tons of teensy GitHub repositories is annoying ;).  Unfortunately,
using Git's submodules self-referentially to checkout local branches
in subdirectories is not supported.  However, the
seperate-repository-per-submodule approach does have benefits for
space saving when folks don't use --reference clones.

README.md: Remove nesting version-control/

There's no need to hard-code target directories in this repository.
Anyone consuming this material can use submodules and pick their own
target directory.

README.md: Remove nesting version-control/git

There's no need to hard-code target directories in this repository.
Anyone consuming this material can use submodules and pick their own
target directory.

instructor.md: Move README.md to instructor.md

This is instructor-facing content.  We still need an inspirational
blurb for the student-facing README.

Conversion of all rst to corresponding markdown files

We use git-flavoured markdown

.mailmap: standardize identifiers for Joshua, Katy, Matt, and Sri

Ignore weird mac DS_Store files.

Update LICENSE.md

Added CC license.
Removed cruft.

README.md: Line wrapping and reference-style links

This makes the README easier to read in a terminal or editor, while
leaving the Markdown output unchanged.

Adding contributing guidelines.

Includes license, workflow, and file formats sections.

Adding some useful developer info and links to the README.

Signed-off-by: Matt Davis <jiffyclub@gmail.com>

.mailmap: Standardize identifiers for Lynne and Matt

version-control/instructor.md: Add a 'Tool choices' section

Software Carpentry is about how to develop software, which is largely
independent of the tooling for a particular task.  This branch only
contains the generic motivation and introduction for version control.
That's nice, but a particular Software Carpentry course or boot camp
*is* going to want to teach a specific tool, and we want instructors
to easily be able to find and integrate notes for the tool they
choose.

This setup doesn't assume that there is a single canonical set of
notes for a given tool.  If you don't like the branches I've listed,
write up your own.  If you tell me about it, I'll add a link to your
branch as well, and we can try and work up some short descriptions to
help new instructors differentiate between the two approaches.

The choices are in the format used by `git request-pull`, so you can
run:

  $ git merge $CHOICE

to merge the branch.  For example:

  $ git merge git://github.com/wking/swc-boot-camps.git version-control-git

without bothering to setup remotes, etc.

version-control/svn: Remove SVN-specific content

This branch is only interested in motivating version control and
providing generic information about it.  Tool-specific information is
contained in tool-specific branches.

version-control: Remove subject-level documents from this SVN branch

This branch should only contain the tool-level content specific to
Subversion.

version-control/README.md: Add a motivational paragraph

The text is adapted from 3976755 (Added the file for lesson 2,
2012-02-04), which I cherry picked out of boot-camps (where it is
d48ceea) [1].

[1] https://github.com/swcarpentry/boot-camps

version-control/cheet-sheet.md: Add a generic outline for the cheat sheet

version-control: Make README.md and instructor.md more generic

Don't assume we're teaching Subversion when explaining why version
control is important or what we expect students to get out of it.  The
Subversion-specific notes are now in the svn subdirectory.

version-control: Add README.md and instructor.md from the guide

Move instructor hints (For Instructors section) and subject outlines
("understand" and "keypoints" classes) from the instructor guide [1]
into the boot camp repository.  This is currently targeted at
Subversion, but making these notes tool-agnostic will come in the next
commit.  Here I just copy the guide content over while translating it
to Markdown.

For posterity, I've grafted on the guide history.  Here's how I
extracted the svn.html history from the guide repository:

1. Start a new branch in the earlier guide repository:

  $ git checkout -b wip d013cab

2. Limit history to svn.html:

  $ git filter-branch -f --prune-empty \
  > --index-filter 'git rm --cached --ignore-unmatch $(git ls-files | grep -v svn.html)' \
  > HEAD

3. Drop no-op merges:

  $ git rebase -i 0025ac4

Then I cherry-picked my original boot-camps commit (c1330e0) onto the
result to create this commit:

  $ git cherry-pick c1330e0
  $ git rm svn.html
  $ git commit --amend

[1]: https://github.com/swcarpentry/guide

Adding status flags

Adding durations

Adding figures

Finishing the revisions to the Subversion chapter

A little more tidy-up

Removing the colon

Reverting files in version control

Tidying up another section of the instructors' guide on SVN

Challenges for SVN intro

Starting to revise instructors' guide on SVN

Added the file for lesson 2

version-control/git/README.md: Add paragraph pitching Git

Why should you use this tool?

version-control/git: Use git-and-github notes

Consolidate on these instructor notes because they are already in a
condensed format.  Remove the long-form local/remote READMEs, whose
content should be merged into the instructor guide.  Flesh out the
cheat sheet with additional commands mentioned in the new instructor
notes.

version-control/git/cheet-sheet.md: Add a Git-specific cheat sheet

Instructor notes for teaching git via collaboration on GitHub.

The focus of the lesson is to have students contribute to a repo on GitHub in
which we are building up a list of the things they are most interested in
learning at the boot camp. Requires everyone have a good internet connection
and that at least some of the participants sign up for GitHub.

swc-nano-installer.py: Remove now that changes are in swc-windows-installer.py

swc-windows-installer.py: Rework install paths to use ~/.swc

Instead of cluttering the user's home directory with multiple
SWC-installed directories, reduce clutter and improve namespacing by
dumping everything inside ~/.swc.  Think of it as a SWC-specific
~/.local.  We avoid actually using ~/.local because users might
already be using that for other purposes.

Use os.makedirs to create the nano install directory if it does not
already exist, because ZipFile.extract uses os.mkdir internally, and
mkdir will not recursively create directories.

swc-windows-installer.py: Remove IPython and nose entry points

Ethan thought these had been fixed upstream, and Aron Ahmadia pointed
to the Anaconda v1.6.2 release notes [1]:

  2013-07-09: 1.6.2: (Windows only)

    Fixed path being incorrectly appended on Windows during install

That means we can drop our entry point scripts and fall back to just
installing Nano and setting up EDITOR.

[1]: http://docs.continuum.io/anaconda/changelog.html

swc-windows-installer.py: De-emphasize Anaconda

Bridge the gap between the original Anaconda plug and Ethan's simpler
"Install Python" from 833d0ee (Add a Nano installer for Windows,
2013-09-17).  As of Anaconda 1.7.0, IPython 1.0.0 and nose 1.3.0 are
included by default [1].

[1]: http://docs.continuum.io/anaconda/pkgs.html

swc-windows-installer.py: Rework paths in main()

Based on Ethan's path handling in 833d0ee (Add a Nano installer for
Windows, 2013-09-17), while still retaining the entry-point creation
for IPython and nose.

swc-windows-installer.py: Generalize update_bash_profile

And rename from make_bash_profile now that we're appending instead of
creating (since c5d5414, Append exports to end of .bash_profile
instead of overwriting, 2013-09-19).

This more general form can be used to add even more paths, for example
our IPython and nosetest entry points.

swc-windows-installer.py: Bring in Ethan's make_bash_profile and make_posix_path

This integerates some of Ethan's nano-installer changes.  In the pull
request, Ethan elaborates on the .bash_profile choice [1]:

  In response to comments on the Tutors list the installer now uses
  .bash_profile instead of .bashrc and appends the lines rather than
  overwriting the file. I have also added comments that indicate where
  the new lines in .bash_profile come from.

  Once the Python version is in I'll move on to getting this compiled
  into a .exe file, which should be more familiar to our students and
  won't run into issues with Canopy installs opening the file in
  Canopy rather than executing it.

The referenced tutors@ discussion is in the messages leading up to
[2], where Ethan top-quotes a discussion with R. David Murray about
the relative merits of .bash_profile and .bashrc.  The imporant point
David made was that .bash_profile is only executed once at login,
while .bashrc is executed for each new shell.  Putting PATH appends in
.bash_profile means that you don't end up adding duplicate entries to
the PATH as you spawn subshells.  For example:

  ${ORIGINAL_PATH}:${NANO_PATH}:${NANO_PATH}:...

[1]: https://github.com/swcarpentry/bc/pull/35
[2]: http://lists.software-carpentry.org/pipermail/tutors_lists.software-carpentry.org/2013-September/000969.html

Merge branch 'nano-installer' into windows-installer

* nano-installer:
  Remove testing line
  Append exports to end of .bash_profile instead of overwriting
  Switch from using .bashrc to .bash_profile nano path and editor export
  Add a Nano installer for Windows

Remove testing line

Append exports to end of .bash_profile instead of overwriting

In the process at an explanation of where the lines came from
so that users know they can remove the lines if desired.

Switch from using .bashrc to .bash_profile nano path and editor export

Add a Nano installer for Windows

1. Downloads and installs Nano into the users home directory
2. Adds Nano to the path
3. Makes Nano the default editor

swc-installation-test-2.py: added support for py.test

swc-windows-installer.py: Use the stdlib's urlopen()

This way I can test the script (on Linux, but whatever) without having
to install an additional package.

swc-windows-installer.py: Use lists for file content

This allows us to keep the usual Python block indentation while still
producing the appropriate wrapper content.

swc-windows-installer.py: Use `with` to write script wrappers

From PEP 343.  This gives you automatic file descriptor (file handles
on Windows?) cleanup on errors.  Also use os.path.join() to build the
paths.

[1]: http://www.python.org/dev/peps/pep-0343/

swc-windows-installer.py: Simplify `ipython` wrapper

This matches my system's `/usr/bin/ipython-2.7`, and is the hook
defined in IPython's setupbase.py:

  'ipython%s = IPython.frontend.terminal.ipapp:launch_new_instance'

This should handle the 'notebook' option internally.

swc-windows-installer.py: Extract nano directly to the install directory

This is more efficient than "extract to . and then copy".  I also
renamed the install_nano() argument.  The function doesn't care that
we're currently passing the Python script directory; it will work
perfectly well with a different directory in the PATH.

swc-windows-installer.py: Avoid writing nano.zip to disk

It's already in memory, and we're going to use it again immediately.
Avoiding the flush-to-disk is both more efficient, and easier to clean
up.

swc-windows-installer.py: Separate requests import from stdlib imports

Python-requests [1] is not part of the stdlib.

[1]: http://docs.python-requests.org/en/latest/

swc-windows-installer.py: Cleanup whitespace

swc-windows-installer.py: Setup msysgit to act like *nix systems

* Install `nano` 2.2.6.
* Add `ipython` and `nosetests` command line entry points.

get-my-ip.py: Python 2.x sockets can't be used in 'with' statements

They don't have __exit__.  Use an explicit try/except block to be
compatible with both 2.x and 3.x.

get-my-ip.py: Add a script for getting your public IP address

This will help students connect to each other on the LAN during class.
Note that if you ping a host across a NAT, you'll get your IP inside
the NAT, not the NAT's IP.

swc-installation-test-2.py: Use ProgramFiles environment variable

On Fri, Apr 26, 2013 at 11:45:12AM -0700, Onno Broekmans wrote:
> ... the installation paths you mention are incorrect for the
> majority of modern Windows 7 installations. These are 64-bit
> installations, and they have a special folder for 32-bit programs:
> "C:\Program Files (x86)". So Notepad++ can be found in:
>
>     C:\Program Files (x86)\Notepad++\notepad++.exe
>
> In the script, you could just check for the program's existence
> using both paths ("C:\Program Files" _and_ "C:\Program Files
> (x86)"), or you could use the "ProgramFiles" environment variable.

Environment variable it is!  From the Microsoft docs [1]:

  CSIDL_PROGRAM_FILESX86
    The Program Files folder on 64-bit systems. A typical path is
    C:\Program Files(86).
  ...
  CSIDL_PROGRAM_FILES
    Version 5.0. The Program Files folder. A typical path is
    C:\Program Files.
  ...
  PROGRAMFILES
    Same as CSIDL_PROGRAM_FILES.
  PROGRAMFILES(X86)
    Refers to the C:\Program Files (x86) folder on 64-bit systems.

We're just looking for executables, so it would be ok if we found a
32-bit Notepad++ or a 64-bit Notepad++.  With this commit, we check
both locations (if there are two distinct locations).

[1]: http://technet.microsoft.com/en-us/library/cc749104%28v=ws.10%29.aspx

swc-installation-test-2.py: Also look for extension-less paths

Before this commit, CommandDependency checked self.command (with an
optional extension determined by distutils).  If that check failed to
produce a version stream, we cycled through a list of additional
hard-coded paths.  For example:  Notepad++ used:

  self.command = 'notepad++'
  self.paths = [
      _os.path.join(
          _ROOT_PATH, 'Program Files', 'Notepad++', 'notepad++.exe'),
      ]

Because some MS Windows commands lack the expected '.exe' extension,
but are still present and detected by a number of shells, we should
also look for the extension-less version of the command.

I consolidated the _get_version_stream() logic to build a single list
of paths and loop through it looking for success (and accumulating
errors).  This makes the handling of self.paths less of a special
case, and sets us up for any additional path mangling we may need to
support other poorly standardized OSes ;).

Cleaning up the build process

Bringing in material from main  repo

Initial commit

swc-installation-test-2.py: Add CommandDependency.paths fallbacks

The old CommandDependency implementation assumed that commands would
exist in one of the directories listed in PATH.  This assumption is,
unfortunately, often not satisfied on MS Windows or OS X.  In order to
work around this problem, you can now store a list of fallback paths
that will be tried if there is an error extracting the version stream
from the bare CommandDependency.command.

I've added fallback paths for Notepad++, Firefox, and Google Chrome,
as reported by Ethan White for Windows 7.

swc-installation-test-2.py: Use _ROOT_PATH for MS Windows compatability

I don't think starting a path with os.sep gives you a root path on
Windows.  We need the backslash in _ROOT_PATH, because:

  os.path.join('c:', 'foo')

gives 'c:foo', a path relative to the current directory on drive C: [1].

[1]: http://docs.python.org/3/library/os.path.html#os.path.join

swc-installation-test-2.py: Raise an error on empty version stream

This makes the upcoming mult-path checking easier to implement.

swc-installation-test-2.py: Don't override Popen's 'close_fds'

Or 'shell'.  The support for these options can be flaky, and the
defaults change with Python version depending on what is best
supported [1].

[1]: http://docs.python.org/2/library/subprocess.html#subprocess.Popen

Reported-by: Ethan White <ethan@weecology.org>

swc-installation-test-2.py: Add 'safari'

This works adds support for virtual-browser on OS X.  Matt Davis
reports the locations of Firefox and Chrome as:

  /Applications/Firefox.app
  /Applications/Google\ Chrome.app

but I'm not sure where the executables live underneath those
directories, which we'd probably need if we wanted to extract version
numbers.

swc-installation-test-2.py: Link directly to install docs

Expecting the Software Carpentry maintainers to keep up-to-date
documentation for each system/package pair is not realistic.  Instead,
link to each package's installation instructions (as best I can find
them).  The system/version/package globbing (using fnmatch, see
glob(7)) makes it easy to setup per-system and per-version URLs if you
want to fine-tune the instructions.

swc-installation-test-2.py: Add --help and --verbose

The system information is useful for troubleshooting a student's
installation problems, but it is probably less useful for the student
themselves.  Turn off this troubleshooting information by default and
require the --verbose option to re-enable it.

If we didn't have to maintain support for Python 2.6, we could use
argparse instead of optparse.  The optparse module is deprecated for
2.7, 3.2, and later, but it is still part of the stdandard library.

Also update the README to point out --verbose.

swc-installation-test-2.py: List supported Ubuntu install hints

From http://software-carpentry.org/setup/ubuntu.html, in the order
that they are currently listed.  The page sections don't have the
appropriate anchor IDs yet, but it's still better to link to the
Ubuntu page than to the root setup/ page.