Metadata-Version: 2.1
Name: pyAllegro
Version: 0.0.2
Summary: pyAllegro is a framework, that provides a simple way to use Allegro Web API and Rest AP. 
Home-page: https://github.com/xSzpo/pyAllegro
Author: xSzpo
Author-email: xszpox@gmail.com
License: UNKNOWN
Description: # allegro-api
        
        pyAllegro is a framework, that provides a simple way to use Allegro [Web API](https://allegro.pl/webapi/general.php) and [Rest AP](https://developer.allegro.pl/about/). You don't need to know how RESTful, SOAP or oauth 2.0 works.    
        <br/>
        As for now it's prepared for getting data from allegro - not for managing your account or bidding.   
        
        
        ### Get started:   
        
        1. Go to https://apps.developer.allegro.pl/ and register your app. **You need to setup redirecion url to ```http://localhost:8000```** - it will be your local server that recive your autorization data (oauth 2.0),
        2. Generate your app password [here](https://allegro.pl/myaccount/Settings/security_settings.php/applicationPasswords),
        3. Install pyAllegro with ```pip install pyAllegro```
        4. Import ```from pyAllegro.api import AllegroRestApi, AllegroWebApi```
        5. Setup credentials that you recived from allegro (by default it's saved here: '/Users/{user}/.allegroApiConfig'):
        ```
        WebApi = AllegroWebApi()
        
        WebApi.credentials_set(
                appName='<credentials from allegro>',
                clientId='<credentials from allegro>',
                clientSecred='<credentials from allegro>',
                userLogin='<allegro login>',
                redirectUrl='<redirect uri - the same you provided during app registration on allegro >',
                appPassword='<app password>'
                )
        
        RestApi = AllegroRestApi()
        
        RestApi.credentials_set(
                appName='<credentials from allegro>',
                clientId='<credentials from allegro>',
                clientSecred='<credentials from allegro>',
                redirectUrl='http://localhost:8000'
                )
        ```
        
        
        ### How to use pyAllegro:
        * [WebApi](https://github.com/xSzpo/pyAllegro/blob/master/tutorial_WebApi.ipynb)
        * [RestApi](https://github.com/xSzpo/pyAllegro/blob/master/tutorial_RestApi.ipynb)
        
        
        ### Allegro api documentation:    
        * [Rest Api](https://developer.allegro.pl/documentation/)    
        * [Web Api](https://allegro.pl/webapi/documentation.php)
        
        ### References
        Thanks to: 
        * https://cwsi.pl/ecommerce/allegro/podstawy-obslugi-web-api-allegro-pl-web-services-i-modul-suds-jurko-w-pythonie
        * https://cwsi.pl/ecommerce/allegro/allegro-pl-rest-api-w-pythonie-wprowadzenie/
        
        
        ### To do  
        - [ ] publish package on pypi 
        - [ ] RestApi put 
        - [ ] RestApi delete
        - [ ] restApi post
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
