Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
boguta_m committed Dec 10, 2014
1 parent 05a730c commit de6be6a
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 4 deletions.
18 changes: 15 additions & 3 deletions doc/Getting started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You can get Shiba from PyPi python packet manager or directly from the GitHub re

How does this works?
--------------------
First, import the main *Shiba* module, and create an instance of the *shibaconnection.ShibaConnection* class with your login, token password [1]_ and domain if you want to work on the sanboxed version of the *PriceMinister WebServices*.
First, import the main *Shiba* module, and create an instance of the *shibaconnection.ShibaConnection* class with your login, account token and domain if you want to work on the sanboxed version of the *PriceMinister WebServices*.

Then all you have to do is importing the management module you wish to work with, giving it your instanced connection class, and start dealing with those WebServices through its methods.

Expand All @@ -34,7 +34,7 @@ This example will show you how to get new sales information on your seller accou
from Shiba.shibaconnection import ShibaConnection
from Shiba.salesmanagement import SalesManagement

init = ShibaConnection("mysellerlogin", "mytokenpwd"[, sandbox=True """For testing only purpose"""]) # Look at footnote [1]_ for some help on PriceMinister IDs
init = ShibaConnection("mysellerlogin", "mytokenpwd"[, sandbox=True """For testing purpose only (use Sandbox IDs)"""])
salestool = SalesManagement(init)
newsales = salestool.get_new_sales()

Expand All @@ -51,6 +51,18 @@ And here we go! All you have to do is to find the methods fitting your needs.

Testing
----------
Shiba comes with its tests, get a virtualenv up and run ``nosetests``.
Shiba comes with its tests, both offline and online ones.

*New in 1.1.2*: Tests now running with mock.

Offline testing
^^^^^^^^^^^^^^^
Move into the *offline* subdirectory of *tests/*, and simply run *nosetests*.

Online testing
^^^^^^^^^^^^^^^
If you want to run online test, you will primary need to get a **PriceMinister sandbox account** in order to proceed.

Then open up the *tests/online/Assets/nosetests.cfg* file and fill it up with your sandbox **login** and **token** (not password).

Then simply run *nosetests* inside the *online* tests folder.
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ ____________________

Releases and changelog
----------------------
**8-Dec-2014** *1.1.2* : Set up a new explicit exception for throttling from PriceMinister, named *ShibaQuotaExceededError*. Tests now with mocks instead of remote polling.
**8-Dec-2014** *1.1.2* : Set up a new explicit exception for throttling from PriceMinister, named *ShibaQuotaExceededError*. Testing is now available both offline (using mock XML) and online.

**24-Sep-2014** *1.1.1* : Added explicit and mandatory required dependencies to *setup.py*, indeed installing Shiba before didn't install those.

Expand Down
Binary file modified gh-pages/doctrees/Getting started.doctree
Binary file not shown.
Binary file modified gh-pages/doctrees/Shiba.doctree
Binary file not shown.
Binary file modified gh-pages/doctrees/environment.pickle
Binary file not shown.
Binary file modified gh-pages/doctrees/index.doctree
Binary file not shown.

0 comments on commit de6be6a

Please sign in to comment.