Files
python/README.md

74 lines
2.7 KiB
Markdown
Raw Normal View History

# Exercism Python Track
2014-02-27 17:53:57 -07:00
[![Build Status](https://travis-ci.org/exercism/python.svg?branch=master)](https://travis-ci.org/exercism/python) [![Requirements Status](https://requires.io/github/exercism/python/requirements.svg?branch=master)](https://requires.io/github/exercism/python/requirements/?branch=master)
[![Join the chat at https://gitter.im/exercism/python](https://badges.gitter.im/exercism/python.svg)](https://gitter.im/exercism/python?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2014-02-28 01:58:51 -07:00
2014-02-27 17:53:57 -07:00
Exercism exercises in Python
2014-02-28 01:22:53 -07:00
2017-06-08 11:04:06 +02:00
2014-03-17 23:23:51 -04:00
## Contributing Guide
Please see the [contributing guide](https://github.com/exercism/x-common/blob/master/CONTRIBUTING.md)
2014-03-17 23:23:51 -04:00
2017-06-08 11:04:06 +02:00
## Working on the Exercises
We welcome both improvements to the existing exercises and new exercises.
2017-06-08 11:04:06 +02:00
A list of missing exercise can be found here: http://exercism.io/languages/python/todo
### Conventions
- We use minimalistic stub files for all exercises (#272).
- We use `unittest` (Python Standard Library) and no 3rd-party-framework.
- We use the parameter order `self.assertEqual(actual, expected)` (#440).
### Testing
All exercises must be compatible with Python versions 2.7 and 3.3 upwards.
2017-06-08 11:04:06 +02:00
To test a single exercise (e.g., with Python 2.7):
```
python2.7 test/check-exercises.py [exercise-name]
```
2017-06-08 11:04:06 +02:00
To test all exercises (e.g., with Python 3):
```
2017-06-08 11:04:06 +02:00
python3 test/check-exercises.py
```
2017-06-08 11:04:06 +02:00
### Code Style
The Python code in this repo is meant to follow the [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/) (a stylized version http://pep8.org).
This repo uses [flake8](http://flake8.readthedocs.org/en/latest/) with default settings to enforce the coding standard.
### CI build
This repo uses `travis-ci` in the following configuration: [travis.yml](https://github.com/exercism/python/blob/master/.travis.yml)
2017-06-08 11:04:06 +02:00
It will check automatically the code style, the problem configuration and runns the unittests with all supported Python versions.
## Pull Requests
We :heart: pull requests!
We even :sparkling_heart: them if they contain well written commit messages!
Please write the first line of your commit message in the following style:
```exercise-name: Changes some things```
If there are more details to add, put those into the body of the commit message.
If you're interested, Tim Pope even has an [entire blog post](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) on good commit messages.
If you're new to Git take a look at [this short guide](https://github.com/exercism/x-common/blob/master/CONTRIBUTING.md#git-basics).
## Python icon
The Python logo is an unregistered trademark. We are using a derived logo with the permission of the Python Software Foundation.