Add new plugin to the list - Sylius Import / Export

[gabiudrescu]

https://github.com/solutionDrive/SyliusImportExport

[gabiudrescu]

from what I can see, the plugin is not final, but maybe @lsmith77 or @solutionDrive-Alt can help us whenever they manage to release it in a functional state - at least Proof of Concept.

[lsmith77]

basically we want to wrap up the two open PRs (CSV header validation and making the importers more generic), then we should convert it into a plugin and then its "ready" to be listed I would say, though in that case still very basic and incomplete.

[lsmith77]

cc @Zales0123

[gabiudrescu]

well... it's a good starting point. I'm sure people will find it useful whenever they start doing research on the matter.

anyway, keep up the good work!

[lsmith77]

long term vision for this:

• support all relevant sylius entities (products, categories etc), not just tax and shipment methods
• add support for exporting
• reuse https://github.com/Sylake/SyliusConsumerPlugin/tree/master/src/Projector to make the "projecting" of data -> sylius entities generic
• also integrate https://github.com/php-enqueue to support message queues along with what portphp supports
• make error handling more flexible (ie. fail on invalid, continue, everything in one transaction, or chunked etc)
• collect some meta data during bulk imports (number of items imported, failed items, time taken etc)
• add support for removing/deactivating items next to the current insert/update
• also support calling the importer/exporters via the CLI (x)

[bitbager]

We will need to define what requirements the plugin needs to meet in order to be listed as a ready one. For now, the key things are its stability and documentation. From my point of view, the plugin without the documentation is useless. I also think that we need to require it to be tested due to respect to the Sylius BDD culture.

For now, I think that we can open a PR with a new section for WIP plugins in the README and this is the place packages like this should appear in 🙂

[mattagohni]

@bitbager Documentation is a good point. Is there any guideline what exactly should be documented and to what extent? Should the documentation be more technical or more from user-perspective?

[bitbager]

@solutionDrive-Alt, for now, there's no documentation guideline for plugins, but from my experience, the best way to write it is to keep in mind that a developer who will use it has no idea about its core code and he should not care about it. The key thing is also that for now, as Sylius is a framework, not a platform, the plugins are being installed by developers only. You can take a look at BitBag's README files and follow its standard, for example - https://github.com/bitbag-commerce/CmsPlugin/blob/master/README.md.

[lsmith77]

BTW pushed some code to https://github.com/solutionDrive/SyliusImportExportPlugin

[bitbager]

Added the plugin to WIP section 🙂

[lsmith77]

code is now at https://github.com/friendsofsylius/SyliusImportExportPlugin