Skip to content

Commit 8c2ba02

Browse files
jkeyesjkeyes
committed
Merge pull request intercom#78 from jkeyes/update-changes
Updating documentation.
2 parents 010af48 + 2ed8eda commit 8c2ba02

File tree

6 files changed

+79
-31
lines changed

6 files changed

+79
-31
lines changed

‎AUTHORS.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
python-intercom is written and maintained by John Keyes and various
2+
contributors:
3+
4+
Development Lead
5+
^^^^^^^^^^^^^^^^
6+
7+
- John Keyes <john@keyes.ie> `@jkeyes <https://github.com/jkeyes>`_
8+
9+
Patches and Suggestions
10+
^^^^^^^^^^^^^^^^^^^^^^^
11+
12+
- `vrachnis <https://github.com/vrachnis>`_
13+
- `sdorazio <https://github.com/sdorazio>`_
14+
- `Cameron Maske <https://github.com/cameronmaske>`_
15+
- `Martin-Zack Mekkaoui <https://github.com/mekza>`_
16+
- `Marsel Mavletkulov <https://github.com/marselester>`_
17+
- `Grant McConnaughey <https://github.com/grantmcconnaughey>`_
18+
- `Robert Elliott <https://github.com/greenafrican>`_
19+
20+
Intercom
21+
^^^^^^^^
22+
- `Darragh Curran <https://github.com/darragh>`_
23+
- `Bill de hÓra <https://github.com/dehora>`_
24+
- `Jeff Gardner <https://github.com/erskingardner>`_

‎CHANGES.rst

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -3,51 +3,52 @@ Changelog
33
=========
44

55
* 2.0.beta (not yet released)
6-
* fixed `UnboundLocalError` in `Request.parse_body`.
7-
* added support for replies with an empty body.
6+
* Fixed `UnboundLocalError` in `Request.parse_body`. (`#72 <https://github.com/jkeyes/python-intercom/issues/72>`_)
7+
* Added support for replies with an empty body. (`#72 <https://github.com/jkeyes/python-intercom/issues/72>`_)
8+
* Fixed a bug in identifying changed attributes when creating new resources. (`#77 <https://github.com/jkeyes/python-intercom/issues/77>`_)
89
* 2.0.alpha
9-
* support for Intercom API v2
10-
* support for Python 3
10+
* Added support for Intercom API v2.
11+
* Added support for Python 3.
1112
* 0.2.13
12-
* fix wildcard import from `intercom` `#28 https://github.com/jkeyes/python-intercom/pull/28`_. (https://github.com/marselester)
13+
* Fixed wildcard import from `intercom`. (`#28 <https://github.com/jkeyes/python-intercom/pull/28>`_)
1314
* 0.2.12
14-
* include RTD theme in requirements.txt
15+
* Added RTD theme to requirements.txt
1516
* 0.2.11
16-
* support for events. `#25 <https://github.com/jkeyes/python-intercom/pull/25>`_. (https://github.com/mekza)
17-
* using RTD theme for documentation.
18-
* updated links to Intercom API docs.
17+
* Added support for events. (`#25 <https://github.com/jkeyes/python-intercom/pull/25>`_)
18+
* Using RTD theme for documentation.
19+
* Fixed links to Intercom API docs.
1920
* 0.2.10
20-
* basic support for companies. `#18 <https://github.com/jkeyes/python-intercom/pull/18>`_. (https://github.com/cameronmaske)
21-
* fixed User.delete. `#19 <https://github.com/jkeyes/python-intercom/pull/19>`_. (https://github.com/cameronmaske)
22-
* updated links to Intercom API docs.
23-
* Doctest fixes.
21+
* Added basic support for companies. (`#18 <https://github.com/jkeyes/python-intercom/pull/18>`_)
22+
* Fixed User.delete. (`#19 <https://github.com/jkeyes/python-intercom/pull/19>`_)
23+
* Fixed links to Intercom API docs.
24+
* Fixed doctests.
2425
* 0.2.9
25-
* `unsubscribed_from_emails` attribute added to `User` object. `#15 <https://github.com/jkeyes/python-intercom/pull/15>`_. (https://github.com/sdorazio)
26-
* `last_request_at` parameter supported in `Intercom.create_user`. `#16 <https://github.com/jkeyes/python-intercom/issues/16>`_.
27-
* page, per_page, tag_id, and tag_name parameters support on `Intercom.get_users`. `#17 <https://github.com/jkeyes/python-intercom/issues/17>`_.
26+
* Added `unsubscribed_from_emails` attribute to `User` object. (`#15 <https://github.com/jkeyes/python-intercom/pull/15>`_)
27+
* Added support for `last_request_at` parameter in `Intercom.create_user`. (`#16 <https://github.com/jkeyes/python-intercom/issues/16>`_)
28+
* Added support for page, per_page, tag_id, and tag_name parameters on `Intercom.get_users`. (`#17 <https://github.com/jkeyes/python-intercom/issues/17>`_)
2829
* 0.2.8
29-
* Added support for tagging `#13 <https://github.com/jkeyes/python-intercom/issues/13>`_.
30-
* Now installs into a clean python environment (https://github.com/vrachil) `#12 <https://github.com/jkeyes/python-intercom/issues/12>`_.
31-
* Doctest fix.
32-
* PEP8 formatting.
30+
* Added support for tagging. (`#13 <https://github.com/jkeyes/python-intercom/issues/13>`_)
31+
* Fixed installation into a clean python environment. (`#12 <https://github.com/jkeyes/python-intercom/issues/12>`_)
32+
* Fixed doctest.
33+
* Updated PEP8 formatting.
3334
* 0.2.7
34-
* Update delete user support to send bodyless request.
35-
* Add support for user notes.
35+
* Fixed delete user support to send bodyless request.
36+
* Added support for user notes.
3637
* 0.2.6
37-
* Support for delete user.
38+
* Added support for delete user.
3839
* 0.2.5
39-
* Consistent version numbering (docs and code).
40+
* Fixed consistent version numbering (docs and code).
4041
* 0.2.4
41-
* Handle invalid JSON responses. (https://github.com/marselester)
42-
* Fix to doctests to pass with current Intercom dummy API.
42+
* Fixed handling of invalid JSON responses.
43+
* Fixed doctests to pass with current Intercom dummy API.
4344
* 0.2.3
4445
* Fixed version number of distribution to match documentation.
4546
* 0.2.2
46-
* Finished docstrings and doctests.
47+
* Updated docstrings and doctests.
4748
* 0.2.1
4849
* Added some docstrings.
4950
* 0.2
50-
* created source distribution `#2 <https://github.com/jkeyes/python-intercom/issues/2>`_.
51-
* renamed errors `#1 <https://github.com/jkeyes/python-intercom/issues/1>`_.
51+
* Created source distribution. (`#2 <https://github.com/jkeyes/python-intercom/issues/2>`_)
52+
* Fixed error names. (`#1 <https://github.com/jkeyes/python-intercom/issues/1>`_)
5253
* 0.1
53-
* initial release
54+
* Initial release.

‎README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# python-intercom
22
=================
33

4+
5+
[ ![PyPI Version](https://img.shields.io/pypi/v/python-intercom.svg) ](https://pypi.python.org/pypi/python-intercom)
6+
[ ![PyPI Downloads](https://img.shields.io/pypi/dm/python-intercom.svg) ](https://pypi.python.org/pypi/python-intercom)
7+
[ ![Travis CI Build](https://travis-ci.org/jkeyes/python-intercom.svg) ](https://travis-ci.org/jkeyes/python-intercom)
8+
49
Python bindings for the Intercom API (https://api.intercom.io).
510

611
[API Documentation](https://api.intercom.io/docs).

‎docs/development.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,8 @@ Development Dependencies
5151
* `mock <http://www.voidspace.org.uk/python/mock/>`_ – patching methods for unit testing.
5252
* `Sphinx <http://sphinx.pocoo.org/>`_ – documentation decorator.
5353

54+
55+
Authors
56+
-------
57+
58+
.. include:: ../AUTHORS.rst

‎docs/faq.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
FAQ
2+
===
3+
4+
How do I start a session?
5+
-------------------------
6+
7+
::
8+
9+
user = User.create(email='bingo@example.com')
10+
# register a new session
11+
user.new_session = True
12+
user.save()

‎docs/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ python-intercom
66
:hidden:
77

88
installation
9-
api/modules
9+
faq
1010
changelog
1111
development
12+
api/modules
1213

1314
Installation
1415
============

0 commit comments

Comments
 (0)