Skip to content

Commit

Permalink
Merge pull request #6 from gwinn/master
Browse files Browse the repository at this point in the history
Update package data for PyPi
  • Loading branch information
gwinn committed Mar 20, 2018
2 parents f9a10e5 + e233b97 commit 857aba1
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 4 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@
/*.egg-info
/dist/
/venv/
/.vscode/
/.vscode/
/build/
79 changes: 79 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
retailCRM python API client
===========================

This is python retailCRM API client. This library allows to use all
available API versions.

Install
-------

::

pip install retailcrm

Usage
-----


.. code:: python

# coding utf-8

import retailcrm


client = retailcrm.v3('https://demo.retailcrm.ru', 'uLxXKBwjQteE9NkO3cJAqTXNwvKktaTc')

order = {
'firstName': 'John',
'lastName': 'Doe',
'phone': '+79000000000',
'email': 'john@example.com',
'orderMethod': 'call-request',
}

result = client.order_create(order)


.. code:: python

# coding utf-8

import retailcrm


client = retailcrm.v4('https://demo.retailcrm.ru', 'uLxXKBwjQteE9NkO3cJAqTXNwvKktaTc')

result = client.customers_history(filter={'sinceId': '1500', 'startDate': '2018-03-01'})

print(result['pagination']['totalCount'])


.. code:: python

# coding utf-8

import retailcrm


client = retailcrm.v5('https://demo.retailcrm.ru', 'uLxXKBwjQteE9NkO3cJAqTXNwvKktaTc')
site = 'example-com'
task = {
'text': 'Product availability problem',
'commentary': 'Take a look ASAP',
'order': {
'externalId': '100500'
},
'performerId': 1
}

result = client.task_create(task, site)

Documentation
-------------

- `English`_
- `Russian`_

.. _English: http://www.retailcrm.pro/docs/Developers/Index
.. _Russian: http://www.retailcrm.ru/docs/Developers/Index
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ def read(fname):

setup(
name='retailcrm',
version='5.0.0',
version='5.0.1',
description='retailCRM API client',
long_description=read('README.md'),
long_description=read('README'),
url='https://github.com/retailcrm/api-client-python',
author='retailCRM',
author_email='integration@retailcrm.ru',
keywords='crm, saas, rest, e-commerce',
keywords='crm saas rest e-commerce',
license='MIT',
packages=['retailcrm', 'tests'],
package_data={},
Expand Down

0 comments on commit 857aba1

Please sign in to comment.