No documentation

[MikeHibbert]

Hi

I'm interested in using this module but it needs a basic HOWTO so its possible to see how to use it.

Mike

[nerdoc]

Hi Mike, though I am releasing this as stable some-day™ ;-), it is not ATM. I have some trouble with the parser as I transcoded it nearly 1:1 from the very good PHP implementation of metroplex systems. If you want you can add some code / help out a bit, I think that most parts are quite well. As said in the README, it's pre-alpha.

I'll write a proper HOWTO, or at least include it in the README - that's a good idea.

[nerdoc]

I wrote a really simple usecase in the README. Please tell me what else you need.

[monkeypants]

We are evaluating this for a project, if the project goes ahead then we will be happy to contribute time to the features/changes we need. It would be helpful if you documented:

• any shortcomings in pydifact you are aware of
• things that you think need more work done to them
• alternatives in the python ecosystem users might consider

[nerdoc]

I'm really glad to see someone else has interest in this (as I before couldn't believe that no library exists with this purpose). I am no professional software engineer, so code quality may not expect your high expectations. This Library is done in my free time - but I will need it for another, (really) huger project as essential plugin part. So I need this to work reliably. To answer your questions:

• Known shortcomings:
  • It may read and parse correctly, but does not support yet "higher" levels of EDIFACT - like envelopes, and "profiles" (or "purposes": medical, financial exchange etc.) - these need to be added.
  • It was transcoded from PHP, and in some parts could be more pythonic in the API.
• Things that need more work:
  • Documentation. Excessively.
  • More testing is needed (one can't test enough). Maybe a testing/CI framework added.
  • Although the official recommendation of the EDIFACT encoding is ISO-8859, I've seen others in the wild. Pydifact should deal with them to be more error-prone.
• Alternatives in the Python eco system:
  • python-edifact - simpler, IMHO less cleaner code, less flexible. may be faster though (not tested).
  • bots - huge, with webinterface (bots-monitor), webserver, bots-engine. Seemed to big and complicated for my purpose as simple library - I never got it running properly. Can be my fault.
  • edicat - simple, only for separating lines/segments for CLIpiping

[monkeypants]

Thanks! great answer. Would you accept a PR with that in the README?

[nerdoc]

Sure! Any PR that helps is welcome!

[nerdoc]

Do you need more? Is there anything I can do? Can I close this issue from your side?

[JocelynDelalande]

On that documentation topic, what about uploading the sphinx doc on readthedocs.io to improve its visibility, even if it is bare API doc.

[nerdoc]

Yes, I already have a project there. But last time it failed to build, and I had no time yet. Let's see what I can do.

[nerdoc]

Ok, it was just a small setting (master_doc). Done. So the No documentation issue can be closed: https://pydifact.readthedocs.io If this is too few documentation for anyone, he/she could open another issue - or help writing it ;-)