django-reusable-app icon indicating copy to clipboard operation
django-reusable-app copied to clipboard

Add a package manifest

Open mjumbewu opened this issue 12 years ago • 2 comments
trafficstars

So that the readme gets pulled up to pypi, among other things.

mjumbewu avatar Jan 14 '13 16:01 mjumbewu

Ok, what effect does that have then? REST framework doesn't currently include them, and I'd normally only use the manifest for stuff actually in the package, so I'm not sure what difference this'd make to the package or PyPI listing of the package.

On 14 January 2013 16:49, Mjumbe Poe [email protected] wrote:

So that the readme gets pulled up to pypi, among other things.

You can merge this Pull Request by running

git pull https://github.com/mjumbewu/django-reusable-app master

Or view, comment on, or merge it at:

https://github.com/dabapps/django-reusable-app/pull/3 Commit Summary

  • Add a project manifest

File Changes

  • A MANIFEST.in (2)

Patch Links:

  • https://github.com/dabapps/django-reusable-app/pull/3.patch
  • https://github.com/dabapps/django-reusable-app/pull/3.diff

lovelydinosaur avatar Jan 14 '13 17:01 lovelydinosaur

If you include the README in the actual package, the pypi listing shows the readme contents. Compare http://pypi.python.org/pypi/djangorestframework with http://pypi.python.org/pypi/django-jstemplate. In fact, it will also include CHANGELOG and, I believe, LICENSE.

There's definitely an argument to be had for not including it (since no one will ever look at the README in the actual package source), but it's nice to have that extra context on packages when browsing PyPI. I believe there's also a way to manually set the package details, but you'd have to update it manually each time you change the README/CHANGELOG content.

mjumbewu avatar Jan 14 '13 17:01 mjumbewu