pymilter icon indicating copy to clipboard operation
pymilter copied to clipboard

Docummentation about python support

Open gleopoldo opened this issue 4 years ago • 6 comments

Hello,

I don't think if this can/should be handled as an issue, but I guess that it would be a nice way to document something that I think might also be a doubt for other people: what are the currently supported python versions in this project?

And about the recent releases, can I safely upgrade my python2.7 project safely? What were the main changes included in those releases? I searched for a changelog in this project but haven't found one yet.

Thanks for the help!

gleopoldo avatar May 15 '20 17:05 gleopoldo

The major change for py3 is that several callbacks pass str instead of bytes. This by itself is fairly natural and transparent - except when the email has invalid utf-8. (Utf-8 is the official 8-bit smtp encoding for envelope and headers.) The current version passes surrogate escapes for invalid utf-8, allowing you to recover original bytes. But that is hardly transparent. There are also hooks to get the original bytes before they are passed to Milter callbacks.

As to where explanations such as the above should go - I suppose in the pymilter.org page.

sdgathman avatar May 15 '20 23:05 sdgathman

Nice!

Thanks for your help! I didn't know about that site, I'm going to read that documentation too. Besides, I don't know what's the community's primary choice to search documentation for python projects, because I'm coming from the ruby community, and I'm accustomed to go straight to the github first. Thus, I haven't even noticed that an online documentation exists...

Do you think that we could add this URL to your README? WDYT?

gleopoldo avatar May 16 '20 21:05 gleopoldo

Do you think that we could add this URL to your README? WDYT?

Yes!

I started migrating from sourceforge to github when I finally bit the bullet and started converting CVS -> GIT. Then when Microsoft bought github, I start migrating back to sourceforge. But then I calmed down and realized that the nature of git meant that the worst MS could do was deny the public exposure - and their corporate culture has changed quite a bit since the Balmer days. So the links to docs and stuff are still somewhat of a mess. I'm working on it.

sdgathman avatar May 19 '20 17:05 sdgathman

Nice! There's something that we could help?

I personally would like if I could contribute with something. I work developing an e-mail sending platform and the milter protocol is very obscure to me. It could be awesome to learn about, and, if possible, contribute with better documentation about it.

gleopoldo avatar May 19 '20 21:05 gleopoldo

@gleopoldo Here is the repo for the top level at https://pymilter.org

https://github.com/sdgathman/milter/tree/master/doc

sdgathman avatar Jun 05 '20 03:06 sdgathman

@gleopoldo I am learning hugo, and have converted a few of my sites to use it. The simple template system used by pymilter.org is getting ancient.

sdgathman avatar Dec 15 '21 23:12 sdgathman