diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..dd12a2a469 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +# Contributing to Learn.co Curriculum + +We're really exited that you're about to contribute to the [open curriculum](https://learn.co/content-license) on [Learn.co](https://learn.co). If this is your first time contributing, please continue reading to learn how to make the most meaningful and useful impact possible. + +## Raising an Issue to Encourage a Contribution + +If you notice a problem with the curriculum that you believe needs improvement +but you're unable to make the change yourself, you should raise a Github issue +containing a clear description of the problem. Include relevant snippets of +the content and/or screenshots if applicable. Curriculum owners regularly review +issue lists and your issue will be prioritized and addressed as appropriate. + +## Submitting a Pull Request to Suggest an Improvement + +If you see an opportunity for improvement and can make the change yourself go +ahead and use a typical git workflow to make it happen: + +* Fork this curriculum repository +* Make the change on your fork, with descriptive commits in the standard format +* Open a Pull Request against this repo + +A curriculum owner will review your change and approve or comment on it in due +course. + +# Why Contribute? + +Curriculum on Learn is publicly and freely available under Learn's +[Educational Content License](https://learn.co/content-license). By +embracing an open-source contribution model, our goal is for the curriculum +on Learn to become, in time, the best educational content the world has +ever seen. + +We need help from the community of Learners to maintain and improve the +educational content. Everything from fixing typos, to correcting +out-dated information, to improving exposition, to adding better examples, +to fixing tests—all contributions to making the curriculum more effective are +welcome. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000000..a297d511e1 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,23 @@ +# Learn.co Educational Content License + +Copyright (c) 2018 Flatiron School, Inc + +The Flatiron School, Inc. owns this Educational Content. However, the Flatiron +School supports the development and availability of educational materials in +the public domain. Therefore, the Flatiron School grants Users of the Flatiron +Educational Content set forth in this repository certain rights to reuse, build +upon and share such Educational Content subject to the terms of the Educational +Content License set forth [here](http://learn.co/content-license) +(http://learn.co/content-license). You must read carefully the terms and +conditions contained in the Educational Content License as such terms govern +access to and use of the Educational Content. + +Flatiron School is willing to allow you access to and use of the Educational +Content only on the condition that you accept all of the terms and conditions +contained in the Educational Content License set forth +[here](http://learn.co/content-license) (http://learn.co/content-license). By +accessing and/or using the Educational Content, you are agreeing to all of the +terms and conditions contained in the Educational Content License. If you do +not agree to any or all of the terms of the Educational Content License, you +are prohibited from accessing, reviewing or using in any way the Educational +Content. diff --git a/README.md b/README.md index a8136d4fbd..cb777faa5e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ### Introduction -Now that you know about variables, you want to use them to associate them with some data. Here, we will be using variables to store information related to a vacation that we would like to go on. +Now that we know about variables, we want to put them to use by associating them with some data. Here, we will be using variables to store information related to a vacation that we would like to go on. Just as before, we ask you to run the code and ensure that it matches what is commented out. @@ -14,21 +14,21 @@ Just as before, we ask you to run the code and ensure that it matches what is co ### Assigning variables -Assign a variable of `travel_month` equal to the string "January", as that is the month you would like to travel. +Assign a variable of `travel_month` equal to the string "January", as that is the month we would like to travel. ```python travel_month = None ``` -> We start by setting the variable equal to the data type None. As you know, `None` represents the absence of a value. And now you can take care of assigning the variable to something other than `None`. +> We start by setting the variable equal to the data type None. As we know, `None` represents the absence of a value. Now we can take care of assigning the variable to something other than `None`. ```python travel_month # "January" ``` -Now let's assign a variable equal to the number of weeks that you would like to travel, 3. +Now let's assign a variable equal to the number of weeks that we would like to travel, 3. ```python @@ -40,7 +40,7 @@ number_of_weeks = None number_of_weeks # 3 ``` -Now, you just learned that you can travel for a longer period of time. So reassign the `number_of_weeks` variable equal to `5`. +UPDATE: we just learned that we can travel for a longer period of time. So, we need to reassign the `number_of_weeks` variable equal to `5`. ```python @@ -51,4 +51,4 @@ Now that's more like it. ### Summary -Great! In this lab, you were able to get a sense how to store information in variables through assignment and reassignment. +Great! In this lab, we were able to get a sense how to store information in variables through assignment and reassignment. diff --git a/_trial_temp/_trial_marker b/_trial_temp/_trial_marker deleted file mode 100755 index e69de29bb2..0000000000 diff --git a/_trial_temp/test.log b/_trial_temp/test.log deleted file mode 100644 index 19ec5ea349..0000000000 --- a/_trial_temp/test.log +++ /dev/null @@ -1,2 +0,0 @@ -2018-03-09 13:12:47-0500 [-] Log opened. -2018-03-09 13:12:47-0500 [-] --> index_test.TestVariables.test_variables_intro <-- diff --git a/future_tests/index_test.py b/future_tests/index_test.py new file mode 100644 index 0000000000..aa60fde237 --- /dev/null +++ b/future_tests/index_test.py @@ -0,0 +1,6 @@ +import unittest2 as unittest +from ipynb.fs.full.index import (travel_month) + +class TestVariables(unittest.TestCase): + def test_travel_month(self): + self.assertEqual(travel_month, 'January') diff --git a/index.ipynb b/index.ipynb index 760b283818..82f6b9f7b0 100644 --- a/index.ipynb +++ b/index.ipynb @@ -18,7 +18,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "Now that you know about variables, you want to use them to associate them with some data. Here, we will be using variables to store information related to a vacation that we would like to go on.\n", + "Now that we know about variables, we want to put them to use by associating them with some data. Here, we will be using variables to store information related to a vacation that we would like to go on.\n", "\n", "Just as before, we ask you to run the code and ensure that it matches what is commented out." ] @@ -49,12 +49,12 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "Assign a variable of `travel_month` equal to the string \"January\", as that is the month you would like to travel." + "Assign a variable of `travel_month` equal to the string \"January\", as that is the month we would like to travel." ] }, { "cell_type": "code", - "execution_count": 7, + "execution_count": 1, "metadata": { "collapsed": true }, @@ -67,13 +67,15 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "> We start by setting the variable equal to the data type None. As you know, `None` represents the absence of a value. And now you can take care of assigning the variable to something other than `None`." + "> We start by setting the variable equal to the data type None. As we know, `None` represents the absence of a value. Now we can take care of assigning the variable to something other than `None`." ] }, { "cell_type": "code", - "execution_count": 8, - "metadata": {}, + "execution_count": 2, + "metadata": { + "collapsed": true + }, "outputs": [], "source": [ "travel_month # \"January\"" @@ -83,12 +85,12 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "Now let's assign a variable equal to the number of weeks that you would like to travel, 3. " + "Now let's assign a variable equal to the number of weeks that we would like to travel, 3. " ] }, { "cell_type": "code", - "execution_count": 9, + "execution_count": 3, "metadata": { "collapsed": true }, @@ -99,7 +101,7 @@ }, { "cell_type": "code", - "execution_count": 10, + "execution_count": 4, "metadata": { "collapsed": true }, @@ -112,12 +114,12 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "Now, you just learned that you can travel for a longer period of time. So reassign the `number_of_weeks` variable equal to `5`." + "UPDATE: we just learned that we can travel for a longer period of time. So, we need to reassign the `number_of_weeks` variable equal to `5`." ] }, { "cell_type": "code", - "execution_count": null, + "execution_count": 5, "metadata": { "collapsed": true }, @@ -144,27 +146,27 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "Great! In this lab, you were able to get a sense how to store information in variables through assignment and reassignment." + "Great! In this lab, we were able to get a sense how to store information in variables through assignment and reassignment." ] } ], "metadata": { "kernelspec": { - "display_name": "Python 3", + "display_name": "Python 2", "language": "python", - "name": "python3" + "name": "python2" }, "language_info": { "codemirror_mode": { "name": "ipython", - "version": 3 + "version": 2 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.6.1" + "pygments_lexer": "ipython2", + "version": "2.7.14" } }, "nbformat": 4, diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000000..f66c0372db --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +pandas +Unittest2 diff --git a/test/__pycache__/index_test.cpython-36.pyc b/test/__pycache__/index_test.cpython-36.pyc deleted file mode 100644 index a696a78a5c..0000000000 Binary files a/test/__pycache__/index_test.cpython-36.pyc and /dev/null differ diff --git a/test/index_test.py b/test/index_test.py deleted file mode 100644 index a0dd684c35..0000000000 --- a/test/index_test.py +++ /dev/null @@ -1,7 +0,0 @@ -import unittest2 as unittest -from twisted.trial import unittest -from ipynb.fs.full.index import (name) - -class TestVariables(unittest.TestCase): - def test_variables_intro(self): - self.assertEqual(name, 'bob')