You are here

README.txt in Feeds extensible parsers 7

Same filename and directory in other branches
  1. 7.2 README.txt
Feeds extensible parsers
========================

A set of extensible parsers for Feeds.
http://drupal.org/project/feeds_ex

Provided parsers
================
- XPath XML & HTML
- QueryPath XML & HTML (requires the QueryPath module)
- JSONPath JSON & JSON lines parser (requires JSONPath)
- JMESPath JSON & JSON linesparser (requires JMESPath and PHP 5.4)

Requirements
============

- Feeds
  http://drupal.org/project/feeds

Installation
============

- Download and enable just like a normal module.

QueryPath
=========
To use the QueryPath parsers, download and enable the QueryPath module.
http://drupal.org/project/querypath

JSONPath
========
To use the JSONPath parser, you'll need PHP >= 5.4.

There are two ways to install it:

1. Without composer:

  1. Download and enable the modules "libraries" and "xautoload".
  2. Download and unpack the following file
     https://github.com/FlowCommunications/JSONPath/archive/0.5.0.tar.gz
     and place the contents of JSONPath-0.5.0 in sites/all/libraries/jsonpath

2. With composer, in sites/all/libraries:

   $ git clone https://github.com/FlowCommunications/JSONPath.git jsonpath
   $ cd jsonpath
   $ composer install --no-dev
   $ drush cc all # Or just clear the cache however you normally would.

JMESPath
========
To use the JMESPath parsers, you'll need Composer, and PHP >= 5.4.
In sites/all/libraries:

$ git clone https://github.com/mtdowling/jmespath.php.git
$ cd jmespath.php
$ composer install --no-dev
$ drush cc all # Or just clear the cache however you normally would.

Development
===========
To run tests locally, the TUnit module is required.
http://drupal.org/project/tunit
One of the goals of this module is to allow other developers to easily create
certain types of parsers. For example, it should be trivial to create a parser
for a specific XML format.
Documention to come.

History
=======
This is the new home for:
- Feeds XPath Parser
- Feeds JSONPath Parser
- Feeds QueryPath Parser
The above modules are all in various states of maintenance. This project is
meant to combine them so that they can benefit from each other's development and
simplify maintenance. There are also some major architectural changes.

There is no upgrade path for the old modules. It remains on the table, but those
modules are still maintained and should continue to work.

File

README.txt
View source
  1. Feeds extensible parsers
  2. ========================
  3. A set of extensible parsers for Feeds.
  4. http://drupal.org/project/feeds_ex
  5. Provided parsers
  6. ================
  7. - XPath XML & HTML
  8. - QueryPath XML & HTML (requires the QueryPath module)
  9. - JSONPath JSON & JSON lines parser (requires JSONPath)
  10. - JMESPath JSON & JSON linesparser (requires JMESPath and PHP 5.4)
  11. Requirements
  12. ============
  13. - Feeds
  14. http://drupal.org/project/feeds
  15. Installation
  16. ============
  17. - Download and enable just like a normal module.
  18. QueryPath
  19. =========
  20. To use the QueryPath parsers, download and enable the QueryPath module.
  21. http://drupal.org/project/querypath
  22. JSONPath
  23. ========
  24. To use the JSONPath parser, you'll need PHP >= 5.4.
  25. There are two ways to install it:
  26. 1. Without composer:
  27. 1. Download and enable the modules "libraries" and "xautoload".
  28. 2. Download and unpack the following file
  29. https://github.com/FlowCommunications/JSONPath/archive/0.5.0.tar.gz
  30. and place the contents of JSONPath-0.5.0 in sites/all/libraries/jsonpath
  31. 2. With composer, in sites/all/libraries:
  32. $ git clone https://github.com/FlowCommunications/JSONPath.git jsonpath
  33. $ cd jsonpath
  34. $ composer install --no-dev
  35. $ drush cc all # Or just clear the cache however you normally would.
  36. JMESPath
  37. ========
  38. To use the JMESPath parsers, you'll need Composer, and PHP >= 5.4.
  39. In sites/all/libraries:
  40. $ git clone https://github.com/mtdowling/jmespath.php.git
  41. $ cd jmespath.php
  42. $ composer install --no-dev
  43. $ drush cc all # Or just clear the cache however you normally would.
  44. Development
  45. ===========
  46. To run tests locally, the TUnit module is required.
  47. http://drupal.org/project/tunit
  48. One of the goals of this module is to allow other developers to easily create
  49. certain types of parsers. For example, it should be trivial to create a parser
  50. for a specific XML format.
  51. Documention to come.
  52. History
  53. =======
  54. This is the new home for:
  55. - Feeds XPath Parser
  56. - Feeds JSONPath Parser
  57. - Feeds QueryPath Parser
  58. The above modules are all in various states of maintenance. This project is
  59. meant to combine them so that they can benefit from each other's development and
  60. simplify maintenance. There are also some major architectural changes.
  61. There is no upgrade path for the old modules. It remains on the table, but those
  62. modules are still maintained and should continue to work.