Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Latest version should declare dependency on markdown>=3.4 #38

Closed
tsibley opened this issue Jul 25, 2022 · 1 comment · Fixed by #39
Closed

Latest version should declare dependency on markdown>=3.4 #38

tsibley opened this issue Jul 25, 2022 · 1 comment · Fixed by #39

Comments

@tsibley
Copy link

tsibley commented Jul 25, 2022

The dependency on markdown in setup.py:

install_requires=['markdown>=3.0.1'],

should be updated to markdown>=3.4 to avoid runtime errors when an older version of markdown is installed.

As it stands now, everyone who worked around #36 by pinning markdown<3.4 now needs to revert that because now it ensures breakage. Folks likely wanted to revert those workarounds anyhow, but this incorrect dep issue also affects new installs of sphinx-markdown-tables where an older markdown is already installed, e.g.:

$ pip install 'markdown<3.4'
Collecting markdown<3.4
  Using cached Markdown-3.3.7-py3-none-any.whl (97 kB)
Collecting importlib-metadata>=4.4
  Using cached importlib_metadata-4.8.3-py3-none-any.whl (17 kB)
Collecting typing-extensions>=3.6.4
  Using cached typing_extensions-4.1.1-py3-none-any.whl (26 kB)
Collecting zipp>=0.5
  Using cached zipp-3.6.0-py3-none-any.whl (5.3 kB)
Installing collected packages: zipp, typing-extensions, importlib-metadata, markdown
Successfully installed importlib-metadata-4.8.3 markdown-3.3.7 typing-extensions-4.1.1 zipp-3.6.0

$ pip install sphinx-markdown-tables
Collecting sphinx-markdown-tables
  Downloading sphinx_markdown_tables-0.0.16-py3-none-any.whl (28 kB)
Requirement already satisfied: markdown>=3.0.1 in ./.venv/lib/python3.6/site-packages (from sphinx-markdown-tables) (3.3.7)
Requirement already satisfied: importlib-metadata>=4.4 in ./.venv/lib/python3.6/site-packages (from markdown>=3.0.1->sphinx-markdown-tables) (4.8.3)
Requirement already satisfied: typing-extensions>=3.6.4 in ./.venv/lib/python3.6/site-packages (from importlib-metadata>=4.4->markdown>=3.0.1->sphinx-markdown-tables) (4.1.1)
Requirement already satisfied: zipp>=0.5 in ./.venv/lib/python3.6/site-packages (from importlib-metadata>=4.4->markdown>=3.0.1->sphinx-markdown-tables) (3.6.0)
Installing collected packages: sphinx-markdown-tables
Successfully installed sphinx-markdown-tables-0.0.16

$ python -c 'import sphinx_markdown_tables; sphinx_markdown_tables.process_tables(None, None, None)'
Traceback (most recent call last):
  File "<string>", line 1, in <module>
  File "…/lib/python3.6/site-packages/sphinx_markdown_tables/__init__.py", line 24, in process_tables
    table_processor = markdown.extensions.tables.TableProcessor(md.parser, {})
TypeError: __init__() takes 2 positional arguments but 3 were given
corneliusroemer added a commit to corneliusroemer/sphinx-markdown-tables that referenced this issue Jul 25, 2022
tsibley added a commit to nextstrain/sphinx-theme that referenced this issue Jul 25, 2022
…d markdown packages"

This reverts commit 88db52c.

sphinx-markdown-tables 0.0.16 was released with a patch.  Unfortunately
its dependencies weren't updated too, so this workaround now actively
breaks our docs builds because the newer sphinx-markdown-tables isn't
compatible with the older markdown version declared here.  See also
<ryanfox/sphinx-markdown-tables#38>.
ryanfox pushed a commit that referenced this issue Jul 29, 2022
@ryanfox
Copy link
Owner

ryanfox commented Jul 29, 2022

New version is available on PyPI. Thank you for the contribution.

tsibley added a commit to nextstrain/cli that referenced this issue Oct 4, 2022
See <ryanfox/sphinx-markdown-tables#38>.

With the downgrade of Sphinx on 3.6 and 3.7 caused by "dev: Require
flake8 ≥4.0.0" (352b8d7), this incorrect dep declaration was causing
issues because Pip thought things were compatible when in reality the
docs build didn't work on those Python versions.
tsibley added a commit to nextstrain/cli that referenced this issue Oct 5, 2022
See <ryanfox/sphinx-markdown-tables#38>.

With the downgrade of Sphinx on 3.6 and 3.7 caused by "dev: Require
flake8 ≥4.0.0" (352b8d7), this incorrect dep declaration was causing
issues because Pip thought things were compatible when in reality the
docs build didn't work on those Python versions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants