search

zopefoundation / DateTime

This package provides a DateTime data type, as known from Zope. Unless you need to communicate with Zope APIs, you're probably better off using Python's built-in datetime module.
Other
19 stars 25 forks source link

Show badges #23

Closed jugmac00 closed 4 years ago

jugmac00 commented 4 years ago

e.g. for Travis build and more...

jugmac00 commented 4 years ago

This is not that easy as it looked like.

The src/DateTime/DateTime.txt is not only used as a README, but also for doctests.

Moving it to the root directory and updating the path for DocFileSuite breaks all doctests with following error message

Test-module import failures:
Module: DateTime.tests.test_datetime
ValueError: Module-relative files may not have absolute paths

Duplicating DateTime.txt is also no option.

Using a minimal README also does not seem right, as then on PyPi there won't be much info any more.

Also, I don't think rewriting doctests is time well spent.

Are there any opinions about what to do? Maybe we just leave it as is, although it would be pretty nice to have a good overview over supported packages and build status when one visits the GitHub repository.

icemac commented 4 years ago

You should go the same route as we did in https://github.com/zopefoundation/zc.beforestorage/pull/3: split the file and put the parts needed into required places but put everything together in long_description of setup.py.

jugmac00 commented 4 years ago

Ah right - thanks @icemac - totally missed this option!