Skip to content

Commit d27f577

Browse files
author
groyoh
committed
Added track specific documentation
1 parent f4084ff commit d27f577

6 files changed

Lines changed: 81 additions & 0 deletions

File tree

config.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@
6363
"trinary"
6464
],
6565
"ignored": [
66+
"docs",
6667
"test"
6768
],
6869
"foregone": [

docs/HELLO.md

Whitespace-only changes.

docs/INSTALLATION.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
If Python isn't already available on your system follow the instructions at [the Hitchhiker's Guide to Python](http://docs.python-guide.org/en/latest/#getting-started) to install Python on your computer.
2+
3+
Exercism currently supports Python3.4, Python3.3 and Python2.7.
4+
5+
6+
## Packages
7+
8+
The [Python Package Index](https://pypi.python.org/pypi) contains thousands of packages.
9+
Pretty much each of them is installable with `pip install packagename`.
10+
If you don't have __pip__ already, [get it now](https://pip.pypa.io/en/latest/installing.html)!

docs/RESOURCES.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Recommended learning resources
2+
3+
* [The Python Tutorial](https://docs.python.org/3/tutorial/)
4+
* [Learn Python The Hard Way](http://learnpythonthehardway.org/book/)
5+
* [Think Python](http://www.greenteapress.com/thinkpython/html/index.html)
6+
* [The Python Library Reference](https://docs.python.org/3/library/index.html)

docs/TOOLS.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## Visual Studio on Windows
2+
3+
Follow the installation instructions for [Python Tools for Visual Studio](https://pytools.codeplex.com/wikipage?title=PTVS%20Installation)
4+
5+
You can either start by creating your own project for working with the Exercism problems or you can download a Visual Studio solution that is already set up.
6+
7+
### Exercism.io Visual Studio Template
8+
9+
This is a Visual Studio template that comes pre-configured to work on the problems in as many languages as Visual Studio supports.
10+
11+
![Solution Explorer](/img/setup/visualstudio/SolutionExplorer.png)
12+
13+
1. Download the [Exercism.io Visual Studio Template](https://github.com/rprouse/Exercism.VisualStudio) from GitHub by clicking the Download Zip button on the page.
14+
2. Unzip the template into your exercises directory, for example `C:\src\exercises`
15+
2. Install the [Exercism CLI](http://help.exercism.io/installing-the-cli.html)
16+
3. Open a command prompt to your exercise directory
17+
4. Add your API key to exercism `exercism configure --key=YOUR_API_KEY`
18+
5. Configure your source directory in exercism `exercism configure --dir=C:\src\exercises`
19+
6. [Fetch your first exercise](http://help.exercism.io/fetching-exercises.html) `exercism fetch python`
20+
7. Open the Exercism solution in Visual Studio
21+
8. Expand the Exercism.python project
22+
9. Click on **Show All Files** in Solution Explorer (See below)
23+
10. The exercise you just fetched will appear greyed out. Right click on the folder and **Include In Project**
24+
11. Get coding...
25+
26+
![Add files](/img/setup/visualstudio/AddFiles.png)
27+
28+
To run the tests, you can do so at the command line, or within Visual Studio.
29+
30+
![Test Explorer](/img/setup/visualstudio/TestExplorer.png)
31+
32+
## Code Style and Linting
33+
34+
There's a style guide called [PEP8](http://legacy.python.org/dev/peps/pep-0008/) that many Python projects adhere to.
35+
Read it when you get a chance!
36+
37+
If you just want a quick overview of some problems in your code, use [pylint](http://www.pylint.org/)!
38+
It can be pretty picky though, so take its results with a grain of salt.
39+
If you don't agree with one of its points, that's a good topic for a discussion in the comments for your program!
40+
41+
If you'd rather have a tool take care of your style issues, take a look at [autopep8](https://github.com/hhatto/autopep8)!
42+
Run `autopep8 -d mycode.py` to get a diff of the changes it proposes and `autopep8 -i mycode.py` to format the code inplace!

docs/WORKFLOW.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Running Tests for an Exercise
2+
3+
Execute tests for an exercise with:
4+
5+
```bash
6+
$ cd exercism/python/bob
7+
$ python bob_test.py
8+
```
9+
10+
## Running Tests for All Exercises
11+
12+
Before running all the tests ensure you have pytest installed:
13+
14+
```bash
15+
$ pip install pytest
16+
```
17+
After pytest is installed all tests can be executed with:
18+
19+
```bash
20+
$ cd exercism/python/
21+
$ py.test
22+
```

0 commit comments

Comments
 (0)