Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
README.md included in a data package not added as a resource in CKAN #60
That sounds like a sensible convention. The original implementation only looked at what was defined in the spec so this was skipped.
Note that READMEs will get currently imported if they are listed as resources in the descriptors just like any other file.
This will be quite a lot trickier than it would appear. We are basically passing the uploaded zipfile to the
I don't want to re-extract the files just to check if there is a README (and we probably can't), so the only thing I can think of is guessing the temp folder where
We probably want to check that there isn't an actual resource with the README to avoid duplication.
For the upcoming PR I have considered that as the datapackage.json would not reference README.md, containing that README.md in the download zip accounts for the README.md file. But as datapackage.json was being created as file (as would never/rarely be large) and then downloaded, so too for README.md (the case would usually/always be README.md is only a small file by comparison), so it would be OK to add this to, a simple zip, which would have a set list of filenames - that's the only way I can consider restricting this atm, unless it should also have some explicit size check (apart from python's zip library constraint for size) (atm just README.md) that could be downloaded in this way (ie: without using queue or considering the delay in creating the zip and downloading. The intention is that the 'simple' zip would never contain potentially very large data resources such as CSV files in the zip.