Skip to content

Commit

Permalink
Edit READMEs to all be consistent
Browse files Browse the repository at this point in the history
  • Loading branch information
econchick committed Jan 19, 2015
1 parent 7d56e7b commit a4ea03e
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 141 deletions.
6 changes: 1 addition & 5 deletions apis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,4 @@
### Project
To build a timeline using [Dipity](http://www.dipity.com) with photos from Flickr and/or 500px. For example, one could make a photo timeline grabbing photos tagged with "Olympics 2012" or "Arab Spring."

### TODOs
* write code.
* write tests.
* write tutorial.
* be awesome.
Follow the complete tutorial [here](http://newcoder.io/api)
56 changes: 1 addition & 55 deletions dataviz/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,58 +3,4 @@
### Project
To parse data from a CSV or Excel file and plot it with matplotlib. Examples include: parsing local crime data and visualizing how often crime happens on Mondays versus Thursdays, etc.


### Initial Requirements:
* [Python 2.x](http://www.python.org/download/releases/2.7.3/)
* [git](http://git-scm.com/downloads)
* [virtualenv](http://pypi.python.org/pypi/virtualenv) You can either download directly, or:
* Mac: `$ sudo easy_install virtualenv`
* Ubuntu: `$ sudo apt-get virtualenv`
* Fedora: `$ sudo yum install python-virtualenv`
* Windows: [Download manually](http://pypi.python.org/pypi/virtualenv)
* [virtualenvwrapper](http://pypi.python.org/pypi/virtualenvwrapper) You can either download it directly, or:
* Mac: `$ sudo easy_install virtualenvwrapper`
* Ubuntu: `$ sudo apt-get virtualenvwrapper`
* Fedora: `$ sudo yum install python-virtualenvwrapper`
* For Mac, Ubuntu, and Fedora:
* `$ export WORKON_HOME=~/Envs`
* `$ mkdir -p $WORKON_HOME`
* `$ source /usr/local/bin/virtualenvwrapper.sh`
* Windows: [Download manually](http://pypi.python.org/pypi/virtualenvwrapper) and follow install instructions

* _Note_: If you are running zsh, check out [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh). You can easily activate <code>virualenv</code> and <code>virtualenvwrapper</code> as a plugin in your `.zshrc` file.

### To Run
Within your terminal

* `$ cd` to get to your 'Home' directory
* `$ mkdir Projects && cd Projects` to create a new 'Projects' folder and move to that directory. You can name it whatever you want, just remember what you named it, and where it is.
* `$ git clone https://github.com/econchick/new-coder.git` This clones the New Coder project into the directory you're currently in, which is Projects (unless you named it something else).
* `$ cd new-coder/dataviz` Change into the Data Viz project.
* `$ mkvirtualenv DataVizProj` Make a virtual environment specific to your Data Viz project. You should see (DataVizProject) before your prompt, now.
* `(DataVizProject) $ pip install -r requirements.txt` Now installing package requirements for this project. Your virtual environment will store the required packages in a self-contained area to not mess up with other Python projects.

#### Virtual Env Practice
Just to show the ease of virtualenv and virtualenvwrapper:
* `(DataVizProject) $ deactivate` You've deactivated your virtual environment. You will not have access to those packages we've downloaded until we reactivate the virtual environment again.
* `$ workon DataVizProject` The virtual environment now is reactivated. The packages you previously installed are now accessible. You should see (DataVizProject) before your prompt again.
* `(DataVizProject) $ pip freeze` This will show you the installed packages in this virtual environment.

**Don't forget** to [deactivate](#virtual-env-practice) your virtual environment after you're all done!

#### Full Source
Within your terminal:

* `(DataVizProject) $ cd new-coder/dataviz/lib/full_source`
* `(DataVizProject) $ python dataviz.py --csvfile=<absolute path to csv file> --type=[Days, Type, Map] --delimiter=<csv file delimiter>`


#### Tutorial Parts
Within your terminal:
* `(DataVizProject) $ cd new-coder/dataviz/lib/tutorial_source`
* Open the desired file (parse.py, graph.py, or map.py) in a text editor
* Edit the `my_file` variable to the full path of your csv file
* Save and return to your terminal
* `(DataVizProject) $ python [parse.py | graph.py | map.py ]`


Follow the complete tutorial [here](http://newcoder.io/dataviz)
20 changes: 5 additions & 15 deletions gui/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,11 @@
## GUI

### Project
Build a Sudoku game for the desktop!

### TODOs
* write code.
* write tests.
* write tutorial.
* be awesome.
This tutorial walks you through how to make the classic [Sudoku](http://en.wikipedia.org/wiki/Sudoku) game as a GUI (Graphical User Interface) using Python’s built-in GUI library, [tkinter](https://wiki.python.org/moin/TkInter).

Follow the complete tutorial [here](http://newcoder.io/gui)


**NOTE**: Tutorial language for testing is not yet complete, but the code for tests can be found in `sudokutest.py`.

### Sudoku links
* http://www.sudokuwiki.org/sudoku_creation_and_grading.pdf
* http://en.wikipedia.org/wiki/Sudoku
* http://en.wikipedia.org/wiki/Mathematics_of_Sudoku
* http://en.wikipedia.org/wiki/Algorithmics_of_sudoku
* http://stackoverflow.com/questions/201461/shortest-sudoku-solver-in-python-how-does-it-work
* http://kjell.haxx.se/sudoku/
* http://www.opensky.ca/~jdhildeb/software/sudokugen/
* http://norvig.com/sudoku.html
57 changes: 5 additions & 52 deletions network/README.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,8 @@
TalkBackBot
===========
## Networks

Are you tired of “That’s what she said” jokes? Then this bot is for you!
It will join a specified channel and respond to the configured trigger phrases
with what she really said, i.e. a quotation from a notable woman. It will also
respond to any direct message with a quotation.
### Project
This tutorial walks you through how to make an [IRC bot](http://en.wikipedia.org/wiki/Internet_Relay_Chat_bot) with [Twisted](http://twistedmatrix.com). You will be introduced to testing, logging, an overview of how the internet works, as well as event-driven programming, different internet protocols, and making a portable application.

Many quotes taken from this excellent resource:
http://womenshistory.about.com/library/qu/blqulist.htm
The project’s code is based off of [Jessamyn Smith](https://twitter.com/jessamynsmith)’s IRC bot – the [talkbackbot](https://github.com/jessamynsmith/talkbackbot), where if anyone says “That’s what she said” in an IRC channel, the bot replies with a notable quote from a woman (that’s what she really said!).

Setup
-----

I highly recommend both virtualenv and virtualenvwrapper to manage the
environments for your different python projects.

::

# Create a virtualenv
mkvirtualenv talkbackbot

# Install requirements
workon talkbackbot
pip install -r requirements.txt

Usage
-----

::

# Activate your virtualenv
workon talkbackbot

# Copy settings.ini.EXAMPLE to settings.ini and edit to suit yourself
cp settings.ini.EXAMPLE settings.ini
vim settings.ini

# Run the bot
twistd -n twsrs

# OR if you have 'make' installed
make run

# Optionally, you can set the config file
twistd -n twsrs -c some-other-file.ini

# Stop the bot
<Ctrl-C>

# Run unit tests
trial tests

# OR if you have 'make' installed
make cov
Follow the complete tutorial [here](http://newcoder.io/networks)
15 changes: 1 addition & 14 deletions scrape/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,4 @@
### Project
Scrape data from a regularly updated website (e.g. cafeteria's weekly lunch menu, local bank interest rates, Groupon/LivingSocial/etc deals), save to a database (postgres), hook up to a cron job, and use the Data Visualization tutorial to play with different visualization techniques.

#### Full Source
Within your terminal:

* Create database for storing scraped data
* `(WebScraperProj) $ cd new-coder/living_social`
* Edit settings.py and set your database settings
* `(WebScraperProj) $ scrapy crawl livingsocial`

#### Running tests
Within your terminal:

* `(WebScraperProj) $ cd new-coder/scrape/living_social`
* `(WebScraperProj) $ scrapy check livingsocial`

Follow the complete tutorial [here](http://newcoder.io/scrape)
10 changes: 10 additions & 0 deletions website/_containers/gui/2015-01-14-extended.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,16 @@ Like playing around with GUIs? Why not try to create:
* Mailing list: [PyQt mailing list](http://www.riverbankcomputing.com/mailman/listinfo/pyqt)
* Article: Some really nice and extensive [personal notes](http://phaseit.net/claird/comp.lang.python/python_GUI.html) from [Cameron Laird](https://wiki.python.org/moin/CameronLaird)

### Sudoku links
* http://www.sudokuwiki.org/sudoku_creation_and_grading.pdf
* http://en.wikipedia.org/wiki/Mathematics_of_Sudoku
* http://en.wikipedia.org/wiki/Algorithmics_of_sudoku
* http://stackoverflow.com/questions/201461/shortest-sudoku-solver-in-python-how-does-it-work
* http://kjell.haxx.se/sudoku/
* http://www.opensky.ca/~jdhildeb/software/sudokugen/
* http://norvig.com/sudoku.html



<br/>
<nav>
Expand Down

0 comments on commit a4ea03e

Please sign in to comment.