Skip to content

Commit

Permalink
update docs for v2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
snarfed committed Mar 1, 2019
1 parent 06c1d76 commit 4e4a1ca
Showing 1 changed file with 41 additions and 34 deletions.
75 changes: 41 additions & 34 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ About
Granary is a library and REST API that fetches and converts between a
wide variety of data sources and formats:

- Facebook, Flickr, GitHub, Google+, Instagram, and Twitter native APIs
- Instagram and Google+ scraped HTML
- Facebook, Flickr, GitHub, Instagram, and Twitter native APIs
- Instagram scraped HTML
- `ActivityStreams <http://activitystrea.ms/>`__ 1.0 and 2.0 (JSON)
- HTML and JSON with
`microformats2 <http://microformats.org/wiki/microformats2>`__
Expand Down Expand Up @@ -125,14 +125,13 @@ envelope <https://opensocial.github.io/spec/2.0.1/Social-API-Server.xml#Activity
which puts the activities in the top-level ``items`` field as a list and
adds the ``itemsPerPage``, ``totalCount``, etc. fields.

Most Facebook requests and all Twitter, Google+, Instagram, and Flickr
requests will need OAuth access tokens. If you’re using Python on Google
App Engine, `oauth-dropins <https://github.com/snarfed/oauth-dropins>`__
is an easy way to add OAuth client flows for these sites. Otherwise,
here are the sites’ authentication docs:
Most Facebook requests and all Twitter, Instagram, and Flickr requests
will need OAuth access tokens. If you’re using Python on Google App
Engine, `oauth-dropins <https://github.com/snarfed/oauth-dropins>`__ is
an easy way to add OAuth client flows for these sites. Otherwise, here
are the sites’ authentication docs:
`Facebook <https://developers.facebook.com/docs/facebook-login/access-tokens/>`__,
`Flickr <https://www.flickr.com/services/api/auth.oauth.html>`__,
`Google+ <https://developers.google.com/+/api/oauth#about>`__,
`Instagram <http://instagram.com/developer/authentication/>`__,
`Twitter <https://dev.twitter.com/docs/auth/3-legged-authorization>`__.

Expand Down Expand Up @@ -416,12 +415,11 @@ was an open source product, but shuttered on 18 July 2016. There’s also
the lifelogging/lifestream aggregator vein of projects that pull data
from multiple source sites.
`Storytlr <https://github.com/storytlr/storytlr>`__ is a good example.
It doesn’t include Facebook, Google+, or Instagram, but does include a
number of smaller source sites. There are lots of others, e.g. the
`Lifestream WordPress
plugin <http://www.enthropia.com/labs/wp-lifestream/>`__. Unfortunately,
these are generally aimed at end users, not developers, and don’t
usually expose libraries or REST APIs.
It doesn’t include Facebook, or Instagram, but does include a number of
smaller source sites. There are lots of others, e.g. the `Lifestream
WordPress plugin <http://www.enthropia.com/labs/wp-lifestream/>`__.
Unfortunately, these are generally aimed at end users, not developers,
and don’t usually expose libraries or REST APIs.

On the open source side, there are many related projects.
`php-mf2-shim <https://github.com/indieweb/php-mf2-shim>`__ adds
Expand All @@ -433,7 +431,16 @@ Facebook and Twitter’s raw HTML.
Changelog
---------

1.15 - 2019-02-27
2.0 - 2019-03-01
~~~~~~~~~~~~~~~~

*Breaking change*: drop Google+ since `it shuts down in
March <https://developers.google.com/+/api-shutdown>`__. Notably, this
removes the ``googleplus`` module.

.. _section-1:

1.15 - 2019-02-28
~~~~~~~~~~~~~~~~~

- Add RSS 2.0 output!
Expand Down Expand Up @@ -477,12 +484,12 @@ Changelog
- Twitter:

- Update max video upload size from 5MB to 512MB
(`#162 <https://github.com/snarfed/granary/issues/162>`__.
(`#162 <https://github.com/snarfed/granary/issues/162>`__).

- ``/url``: Return HTTP 400 when fetching the user’s URL results in an
infinite redirect.

.. _section-1:
.. _section-2:

1.14 - 2018-11-12
~~~~~~~~~~~~~~~~~
Expand All @@ -509,7 +516,7 @@ Encode ``&``\ s in author URL and email address too. (Thanks
`sebsued <https://twitter.com/sebsued>`__!) \* AS2: \* Add ``Follow``
support.

.. _section-2:
.. _section-3:

1.13 - 2018-08-08
~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -570,7 +577,7 @@ support.
- Support ``alt`` attribute in ``<img>`` tags
(`snarfed/bridgy#756 <https://github.com/snarfed/bridgy/issues/756>`__).

.. _section-3:
.. _section-4:

1.12 - 2018-03-24
~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -605,7 +612,7 @@ impact of the Python 3 migration. It *should* be a noop for existing
Python 2 users, and we’ve tested thoroughly, but I’m sure there are
still bugs. Please file issues if you notice anything broken!

.. _section-4:
.. _section-5:

1.11 - 2018-03-09
~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -678,7 +685,7 @@ still bugs. Please file issues if you notice anything broken!
- Omit title from items if it’s the same as the content. (Often
caused by microformats2’s implied ``p-name`` logic.)

.. _section-5:
.. _section-6:

1.10 - 2017-12-10
~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -720,7 +727,7 @@ still bugs. Please file issues if you notice anything broken!
- Fix bug that omitted title in some cases
(`#122 <https://github.com/snarfed/granary/issues/122>`__).

.. _section-6:
.. _section-7:

1.9 - 2017-10-24
~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -748,7 +755,7 @@ still bugs. Please file issues if you notice anything broken!
``json``, ``json-mf2``, and ``xml`` are still accepted, but
deprecated.

.. _section-7:
.. _section-8:

1.8 - 2017-08-29
~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -828,7 +835,7 @@ still bugs. Please file issues if you notice anything broken!
`bug <https://github.com/kylewm/brevity/issues/5>`__
`fixes <https://github.com/kylewm/brevity/issues/6>`__.

.. _section-8:
.. _section-9:

1.7 - 2017-02-27
~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -876,7 +883,7 @@ still bugs. Please file issues if you notice anything broken!
on “narrow” builds of Python 2 with ``--enable-unicode=ucs2``, which
is the default on Mac OS X, Windows, and older \*nix.

.. _section-9:
.. _section-10:

1.6 - 2016-11-26
~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -910,7 +917,7 @@ still bugs. Please file issues if you notice anything broken!
- Error handling: return HTTP 502 for non-JSON API responses, 504 for
connection failures.

.. _section-10:
.. _section-11:

1.5 - 2016-08-25
~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -948,14 +955,14 @@ still bugs. Please file issues if you notice anything broken!
- Switch creating comments and reactions from GraphQL to REST API
(`bridgy#824 <https://github.com/snarfed/bridgy/issues/824>`__.

.. _section-11:
.. _section-12:

1.4.1 - 2016-06-27
~~~~~~~~~~~~~~~~~~

- Bump oauth-dropins requirement to 1.4.

.. _section-12:
.. _section-13:

1.4.0 - 2016-06-27
~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -989,15 +996,15 @@ still bugs. Please file issues if you notice anything broken!
- Upgrade to requests 2.10.0 and requests-toolbelt 0.60, which support
App Engine.

.. _section-13:
.. _section-14:

1.3.1 - 2016-04-07
~~~~~~~~~~~~~~~~~~

- Update `oauth-dropins <https://github.com/snarfed/oauth-dropins>`__
dependency to >=1.3.

.. _section-14:
.. _section-15:

1.3.0 - 2016-04-06
~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -1040,7 +1047,7 @@ still bugs. Please file issues if you notice anything broken!
- Misc bug fixes.
- Set up Coveralls.

.. _section-15:
.. _section-16:

1.2.0 - 2016-01-11
~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -1096,7 +1103,7 @@ still bugs. Please file issues if you notice anything broken!
- Misc bug fixes.
- Set up CircleCI.

.. _section-16:
.. _section-17:

1.1.0 - 2015-09-06
~~~~~~~~~~~~~~~~~~
Expand All @@ -1119,15 +1126,15 @@ still bugs. Please file issues if you notice anything broken!
- Improve original post discovery algorithm.
- New logo.

.. _section-17:
.. _section-18:

1.0.1 - 2015-07-11
~~~~~~~~~~~~~~~~~~

- Bug fix for atom template rendering.
- Facebook, Instagram: support access_token parameter.

.. _section-18:
.. _section-19:

1.0 - 2015-07-10
~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 4e4a1ca

Please sign in to comment.