Skip to content

711: remove support for enketo-validate#854

Open
lindsay-stevens wants to merge 17 commits into
XLSForm:masterfrom
lindsay-stevens:pyxform-711
Open

711: remove support for enketo-validate#854
lindsay-stevens wants to merge 17 commits into
XLSForm:masterfrom
lindsay-stevens:pyxform-711

Conversation

@lindsay-stevens

Copy link
Copy Markdown
Contributor

Closes #711

Why is this the best possible solution? Were any other approaches considered?

  • Branch based on deps-update / PR 853 branch so only commit 70cfdf7 (or later) are relevant.
  • Minimal removal of enketo related mentions to retain passing tests, i.e. did not re-evaluate the code paths or tests as to whether they were still the best possible path for supporting only ODK Validate.

What are the regression risks?

If someone was using enketo-validate and providing a build of it themselves, then this is a breaking change. But the issue #711 has been open for two years now and nobody has noted an objection.

Does this change require updates to documentation? If so, please file an issue here and include the link below.

No, the only docs for this were the command-line help text, which is now removed.

Before submitting this PR, please make sure you have:

  • included test cases for core behavior and edge cases in tests
  • run python -m unittest and verified all tests pass
  • run ruff format pyxform tests and ruff check pyxform tests to lint code
  • verified that any code or assets from external sources are properly credited in comments

- resolve new warnings on RUF059 (unused vars) and B017 (broad err).
- re-checked commented out rules with ruff version markers, and the
  noted issues are still present, so updated the noted version.
- removes strenum copy which is only present in py3.11+ so that change
  is not backwards compatible. However, ruff warns that keeping it no
  good either since StrEnum exists in py311.
- refurb "A tool for refurbishing and modernizing Python codebases."
- the full pydocstyle ruleset has many changes so enabling some of them
  individually to keep the diffs manageable.
- the full pydocstyle ruleset has many changes so enabling some of them
  individually to keep the diffs manageable.
- the full pydocstyle ruleset has many changes so enabling some of them
  individually to keep the diffs manageable.
- the full pydocstyle ruleset has many changes so enabling some of them
  individually to keep the diffs manageable.
- D415 is a bit strange when it comes to indented inline code blocks,
  so added backticks for those cases as well as URLs.
- the full pydocstyle ruleset has many changes so enabling some of them
  individually to keep the diffs manageable.
- the full pydocstyle ruleset has many changes so enabling some of them
  individually to keep the diffs manageable.
- The previous few commits selectively enabled the pydocstyle rules that
  resulted in changes that seemed reasonable to accept now.
- The rules now in the ignore list are ones that would require a lot of
  manual rewrites (most of them have dozens of hits).
- So this rearrangement enables other potentially useful pydocstyle
  rules that aren't currently triggering changes or warnings.
- `flynt is a command line tool to automatically convert a project's
   Python code from old "%-formatted" and .format(...) strings into
   Python 3.6+'s "f-strings".`
- conversion result in next commit so that file history is kept.
- used `pandoc --wrap=preserve -f rst -t gfm README.rst -o README.md`
  - markdown easier to remember and maintain
- fixed grammatical error L112 "in a easily navigable format"
- removed badges since this info is available on the same page as the
  readme (either GitHub or PyPI) and so one less thing to update.
- updater script has not worked since 2020
- enketo-validate dropped support for binary builds in 2022
- odk is moving towards web-forms instead of enketo
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 this pull request may close these issues.

Remove support for enketo-validate

1 participant