Skip to content

Commit 0b23204

Browse files
committed
README: show how to run tests, fix sample output
1 parent 8eac8c9 commit 0b23204

File tree

1 file changed

+32
-14
lines changed

1 file changed

+32
-14
lines changed

README.rst

+32-14
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,9 @@ Currently it can extract these informations:
1515
* World Manufacturer Identifier
1616
* Year of the vehicle model
1717

18-
This is a work in progress and my only source of information about the many VIN standards
19-
is a half baked Wikipedia article. So don't expect it to be perfect.
20-
21-
Feel free to contribute !
18+
This is a work in progress -- model lookup was only about 90% accurate
19+
in an informal test -- yet appears to be the most complete open source
20+
implementation of vin lookup available. Feel free to contribute !
2221

2322
Low level API example
2423
---------------------
@@ -35,9 +34,9 @@ Low level API example
3534
>>> v.year
3635
2006
3736
>>> v.make
38-
Honada
37+
Chrysler
3938
>>> v.manufacturer
40-
Honada Canda
39+
Chrysler Canada
4140
>>> v.is_pre_2010
4241
True
4342
>>> v.wmi
@@ -156,18 +155,37 @@ European Union & North America (<500 vehicles/year)
156155
Note to contributors
157156
--------------------
158157

159-
When submitting a bug fix, please add an entry to TEST_DATA in tests/__init__.py
160-
that tickles the bug you're fixing. The following free VIN decoder services
161-
may come in handy when preparing test cases:
158+
When submitting a bug fix, please add an entry to TEST_DATA in
159+
tests/__init__.py that tickles the bug you're fixing, and make
160+
sure the test suite passes.
161+
162+
To run the test suite with nose::
163+
164+
$ pip install nose
165+
$ nosetests
166+
167+
To run the test suite with nose2::
168+
169+
$ pip install nose2
170+
$ nose2
171+
172+
Either should output a few test status lines, then end with something like::
173+
174+
Ran 11 tests in 0.007s
175+
176+
OK
177+
178+
The following free VIN decoder services may come in handy when preparing
179+
test cases, at least for cars sold in the United States.
162180
* http://vpic.nhtsa.dot.gov/api/
163181
* http://vpic.nhtsa.dot.gov/decoder/
164182

165183
To find all VIN coding guides from a manufacturer, visit
166-
http://vpic.nhtsa.dot.gov/mid/
167-
check the "Part 565" checkbox, enter part of a manufacturer's name, leave DBA blank,
168-
enter a % wildcard for City, State, Country, and Filename, and click
169-
Search. The resulting filenames are cryptic, and you have to slog
170-
through a lot of files, but the data is pure gold.
184+
* http://vpic.nhtsa.dot.gov/mid/
185+
Then check the "Part 565" checkbox, enter part of a manufacturer's
186+
name, leave DBA blank, enter a % wildcard for City, State, Country,
187+
and Filename, and click Search.
188+
The resulting filenames are cryptic, and you have to slog
171189

172190
References
173191
----------

0 commit comments

Comments
 (0)