1500428 - mozparsers fails to install because it's missing the README.md file

Status: NEW

(Toolkit :: Telemetry, enhancement, P3)

Description

[Alessio Placitelli [:Dexter]]

For some reason the README.md file was not packaged within the mozparsers package. This makes it fail to install via "pip".

We should release a new version of the package containing the readme file. We should also check that it installs properly.

A guide for packagking is available at: https://packaging.python.org/tutorials/packaging-projects/

Comment 1

[Alessio Placitelli [:Dexter]]

While we're here we can also fix the README.md file by adding blank lines between sections and their body, so that they show up correctly on the release pypi realm.

Comment 2

[Jannis Leidel [:jezdez]]

Not having checked the source, is the file included in the MANIFEST.in (read: file manifest template) file?

Comment 3

[Alessio Placitelli [:Dexter]]

(In reply to Jannis Leidel [:jezdez] from comment #2)
> Not having checked the source, is the file included in the MANIFEST.in
> (read: file manifest template) file?

Mh, I can't seem to find this file :\ Where should it live?

Comment 4

[Jannis Leidel [:jezdez]]

(In reply to Alessio Placitelli [:Dexter] from comment #3)
> (In reply to Jannis Leidel [:jezdez] from comment #2)
> > Not having checked the source, is the file included in the MANIFEST.in
> > (read: file manifest template) file?
> 
> Mh, I can't seem to find this file :\ Where should it live?

Just next to the setup.py file. On up-to-date versions of the Python packaging toolset this isn't needed.

IOW you may be running an older version of setuptools locally (which doesn't include the README.md automatically into the source file). Setuptools et al have recently only been update to support README.md (next to README.rst, README.txt and README).

See https://packaging.python.org/guides/making-a-pypi-friendly-readme/