Python Shapeways Documentation

Transcription

1 Python Shapeways Documentation Release Shapeways January 29, 2015

2

3 Contents 1 shapeways.client 3 2 Installing 9 3 Documentation Building Documentation Versions before Indices and tables 15 Python Module Index 17 i

4 ii

5 Contents: Contents 1

6 2 Contents

7 CHAPTER 1 shapeways.client class shapeways.client.client(consumer_key, consumer_secret, callback_url=none, oauth_token=none, oauth_secret=none) Api client for the Shapeways API The API uses OAuth v1 to authenticate clients, so the following steps must be used. 1.Create a client 2.Connect to API and get request token and authentication url 3.Send user to authentication url 4.Verify callback from authentication url Example: client = Client("key", "secret") url = client.connect() # redirect user to url # capture response url from authentication callback client.verify_url(response_url) # make api requests info = client.get_api_info() Constructor for a new shapeways.client.client Parameters consumer_key (str) The API key for your app consumer_secret (str) The API secret key for your app callback_url (str) The url that should be redirected to after successful authentication with Shapeways OAuth oauth_token (str) The OAuth token obtained from calls to connect/verify oauth_secret (str) The OAuth secret obtained from calls to connect/verify add_model(params) Make an API call POST /models/v1 Required Parameters: 1.file - str (the file data) 2.fileName - str 3.hasRightsToModel - bool 3

8 4.acceptTermsAndConditions - bool Optional Parameters: 1.uploadScale - float 2.title - str 3.description - str 4.isPublic - bool 5.isForSale - bool 6.isDownloadable - bool 7.tags - list 8.materials - dict 9.defaultMaterialId - int 10.categories - list Parameters params (dict) dict of necessary parameters to make the api call Returns model upload information Raises Exception when any of the required parameters are missing add_model_file(model_id, params) Make an API call POST /models/{model_id}/files/v1 Required Parameters: 1.file - str (the file data) 2.fileName - str 3.hasRightsToModel - bool 4.acceptTermsAndConditions - bool Optional Parameters: 1.uploadScale - float Parameters model_id (int) the id of the model to upload the file for params (dict) dict of necessary parameters to make the api call Returns file upload information Raises Exception when any of the required parameters are missing add_model_photo(model_id, params) Make an API call POST /models/{model_id}/photos/v1 Required Parameters: 1.file - str (the file data) 4 Chapter 1. shapeways.client

9 Optional Parameters: 1.title - str 2.description - str 3.materialId - int 4.isDefault - bool Parameters model_id (int) the id of the model to upload the photo for params (dict) dict of necessary parameters to make the api call Returns photo upload information Raises Exception when the required parameter is missing add_to_cart(params) Make an API call POST /orders/cart/v1 Required Parameters: 1.modelId - int Optional Parameters: 1.materialId - int 2.quantity - int Parameters params (dict) dict of necessary parameters to make the api call Returns whether or not the call was successful Raises Exception when the required parameter is missing connect() Get an OAuth request token and authentication url Returns the authentication url that the user must visit or None on error Return type str or None delete_model(model_id) Make an API call DELETE /models/{model_id}/v1 Parameters model_id the id of the model to delete Returns information whether or not it was successful get_api_info() Make an API call GET /api/v1 Returns api info 5

10 get_cart() Make an API call GET /orders/cart/v1 Returns items currently in the cart get_categories() Make an API call GET /categories/v1 Returns information about all categories get_category(category_id) Make an API call GET /categories/{category_id}/v1 Parameters category_id (int) the category to fetch information for Returns information about a specific category get_material(material_id) Make an API call GET /materials/{material_id}/v1 Parameters material_id (int) the id of the material to fetch Returns specific materials info get_materials() Make an API call GET /materials/v1 Returns information about all materials get_model(model_id) Make an API call GET /models/{model_id}/v1 Parameters model_id the id of the model to fetch Returns data for a specific model get_model_file(model_id, file_version, include_file=false) Make an API call GET /models/{model_id}/files/{file_version}/v1 Parameters model_id (int) the id of the model to get the file from file_version (int) the file version of the file to fetch include_file (bool) whether or not to include the raw file data in the response Returns the file information get_model_info(model_id) Make an API call GET /models/{model_id}/info/v1 Parameters model_id the id of the model to fetch Returns information for a specific model 6 Chapter 1. shapeways.client

11 get_models(page=none) Make an API call GET /models/v1 Returns information about all user s models get_price(params) Make an API call POST /price/v1 Required Parameters: 1.volume - float 2.area - float 3.xBoundMin - float 4.xBoundMax - float 5.yBoundMin - float 6.yBoundMax - float 7.zBoundMin - float 8.zBoundMax - float Optional Parameters: 1.materials - list Parameters params (dict) dict of necessary parameters to make the api call Returns pricing information for the params given Raises Exception when any of the required parameters are missing get_printer(printer_id) Make an API call GET /printers/{printer_id}/v1 Parameters printer_id (int) the printer to fetch information for Returns information about a specific printer get_printers() Make an API call GET /printers/v1 Returns information about all printers update_model_info(model_id, params) Make an API call PUT /models/{model_id}/info/v1 Optional Parameters: 1.uploadScale - float 2.title - str 3.description - str 7

12 4.isPublic - bool 5.isForSale - bool 6.isDownloadable - bool 7.tags - list 8.materials - dict 9.defaultMaterialId - int 10.categories - list Parameters model_id (int) the id of the model to get the file from params (dict) dict of necessary parameters to make the api call Returns the model information url(path) Generate the full url for an API path client = Client("key", "secret") url = client.url("/api/") # " Parameters path (str) The API path to get the url for Returns the full url to path Return type str verify(oauth_token, oauth_verifier) Get an access token and setup OAuth credentials for further use If you have the full url or query string from the authentication callback then you can use shapeways.client.client.verify_url() which will parse the correct parameters from the query string and call shapeways.client.client.verify() Parameters oauth_token (str) the oauth_token parameter from the authentication callback oauth_verifier (str) the oauth_verifier parameter from the authentication callback verify_url(url) Parse parameters and properly call shapeways.client.client.verify() If you already have the oauth_token and oauth_verifier parameters parsed, use shapeways.client.client.verify() directly instead. Parameters url (str) The response url or query string from the authentication callback 8 Chapter 1. shapeways.client

13 CHAPTER 2 Installing pip install shapeways 9

14 10 Chapter 2. Installing

15 CHAPTER 3 Documentation Documentation can be found at ReadTheDocs. 3.1 Building Documentation Once built the docs can be accessed from /docs/_build/html/index.html git clone git://github.com/shapeways/python-shapeways.git cd python-shapeways make docs 11

16 12 Chapter 3. Documentation

17 CHAPTER 4 Versions before The original client was written and maintained for information about versions earlier than v1.0.0 please visit 13

18 14 Chapter 4. Versions before 1.0.0

19 CHAPTER 5 Indices and tables genindex modindex search 15

20 16 Chapter 5. Indices and tables

21 Python Module Index s shapeways.client, 3 17

22 18 Python Module Index

23 Index A add_model() (shapeways.client.client method), 3 add_model_file() (shapeways.client.client method), 4 add_model_photo() (shapeways.client.client method), 4 add_to_cart() (shapeways.client.client method), 5 C Client (class in shapeways.client), 3 connect() (shapeways.client.client method), 5 D delete_model() (shapeways.client.client method), 5 G get_api_info() (shapeways.client.client method), 5 get_cart() (shapeways.client.client method), 5 get_categories() (shapeways.client.client method), 6 get_category() (shapeways.client.client method), 6 get_material() (shapeways.client.client method), 6 get_materials() (shapeways.client.client method), 6 get_model() (shapeways.client.client method), 6 get_model_file() (shapeways.client.client method), 6 get_model_info() (shapeways.client.client method), 6 get_models() (shapeways.client.client method), 7 get_price() (shapeways.client.client method), 7 get_printer() (shapeways.client.client method), 7 get_printers() (shapeways.client.client method), 7 S shapeways.client (module), 3 U update_model_info() (shapeways.client.client method), 7 url() (shapeways.client.client method), 8 V verify() (shapeways.client.client method), 8 verify_url() (shapeways.client.client method), 8 19