Documentation & github repo are out of date

[Aran-Fey]

I just installed this module and was surprised to find out that

1. The code snippet from the README crashes with a "Unit is not subscriptable" error
2. The list of measurements in the docs is missing a whole bunch of units, like "voltage", "volumetric flow", "resistance", "frequency" and many more. The code for these is nowhere to be found on Github either. Why do these exist in the pypi distribution but nowhere else?

[amotl]

Dear @Aran-Fey,

we can not reproduce anything of what you are reporting here.

1. The example within the README works for us.

   git clone https://github.com/coddingtonbear/python-measurement
   cd python-measurement
   python3 -m venv .venv
   source .venv/bin/activate
   pip install --editable=.
   # Successfully installed measurement-4.0a8.dev3+g99d3397
   python

   >>> from measurement import measures
   >>> measures.Distance("12 megaparsec")["British yard"]
   Decimal('404948208659679393828910.8771')

2. The implementations of the mentioned units can be found at:

   • https://github.com/coddingtonbear/python-measurement/blob/main/measurement/measures/electromagnetism.py
   • https://github.com/coddingtonbear/python-measurement/blob/main/measurement/measures/mechanics.py

   I think that only the documentation would need to get updated. @coddingtonbear will probably be happy about any kind of contribution in order to improve the situation on this matter.

With kind regards,
Andreas.

[Aran-Fey]

You misunderstand; what I'm trying to say is that the code on github doesn't match the code that's distributed via pypi. If you install measurement like so:

pip install measurement

and then try the snippet from the README, this happens:

>>> from measurement import measures
>>> measures.Distance("12 megaparsec")["British yard"]
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'Distance' object is not subscriptable

And if you look at the files in site-packages/measurement/measures, you will find lots of files that don't exist on github, like volumetric_flow.py.

[amotl]

Hi again,

What I'm trying to say is that the code on github doesn't match the code that's distributed via PyPI.

The reason might be that you are installing the most recent stable version, i.e. 3.2.0, from PyPI? The current version, 4.0a7, reflecting the state of the repository, still has a pre-release tag. See also the release history on PyPI.

you will find lots of files that don't exist on github

It is not uncommon that code is being moved around, especially when refactoring for a new major release. Are you sure it is really not within the repository?

like volumetric_flow.py.

Did you check the mechanics.py file I referenced above?

With kind regards,
Andreas.

P.S.: In order to install the version 4.x.x of the measurement package to your machine from PyPI, just type:

pip install --pre --upgrade "measurement>=4a,<5"

[Aran-Fey]

Ah I see, the code on github is newer than the one on pypi. That explains why the README code doesn't work. I didn't realize that you were preparing for a major version bump.

So I guess you're right, it's only the documentation that's outdated.

[amotl]

Dear @Aran-Fey,

we just asked at #64 (comment) what it would take to make the 4.x version generally available and offered to help, when needed at all.

On the matter of documentation, we just found that the measures.rst will generate the list of supported measurements and units automatically from the code base, see [1].

So, we think nothing would have to be improved on this end, other than just releasing and rebuilding the documentation, which might happen automatically then.

With kind regards,
Andreas.

[1] https://github.com/coddingtonbear/python-measurement/blob/main/docs/measures.rst#supported-measures-and-units