Update: Replace deps without python wheels to allow installing in pyodide

[Gizemdem]

Description & motivation

Relates to: https://speckle.community/t/running-specklepy-inside-pyodide-browser/12826/3

This PR replaces two dependencies, which conflict when a user tries to import specklepy in pyodide.
Pyodide is a python port that allows running python programs natively in a browser. This PR would allow installing specklepy in a Python environment running in Pyodide and then extend the possibilities of using these APIs, for example inside a python console running locally in the browser like this one.

Changes:

• Replace usjon -> orjson. This package is the recommended migration by the ujson package. It's also faster (but haven't tested it personally) and safer. (https://pypi.org/project/ujson/)

Users are encouraged to migrate to orjson which is both much faster and less likely to introduce a surprise buffer overflow vulnerability in the future.

• orjson dumps produces bytes, so calling .encode() in the base.py file becomes unnecessary. I validated this with the test test_base.py

• Replace stringcase -> casefy. This dependency has the same API of stringcase but offers a python wheel and is actively maintained. It has no other dependencies.

Screenshots:

Validation of changes:

I haven't added a new test, but I focused on running tests in the unit/ directory. Specially the test_base.py since there are changes on the base file due to changing ujson to orjson.

Checklist:

• My pull request follows the guidelines in the Contributing guide?
• My pull request does not duplicate any other open Pull Requests for the same update/change?
• My commits are related to the pull request and do not amend unrelated code or documentation.
• My code follows a similar style to existing code.
• I have added appropriate tests.
• I have updated or added relevant documentation.

References

https://speckle.community/t/running-specklepy-inside-pyodide-browser/12826/3

[gjedlicska]

hey @Gizemdem your changes are in a good direction let me know if you need help with fixing the tests.

The pre-commit CI step is failing, cause one of the linters is not satisfied, if you install pre-commit it will automatically fix the issues for you

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.65%. Comparing base (fe03d96) to head (0616b9a).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #345   +/-   ##
=======================================
  Coverage   87.65%   87.65%           
=======================================
  Files          95       95           
  Lines        5670     5670           
=======================================
  Hits         4970     4970           
  Misses        700      700           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[gjedlicska]

hey @JR-Morgan and @KatKatKateryna i think we're on solid foundations here to go ahead, could you do a bit of testing in blender and qgis before we merge this?

[andrsbtrg]

hey everyone! I noticed a small thing: this PR is pinning the minimum verson of orjson to 3.10.6, but the latest version of orjson that works in pyodide is 3.10.1 https://pyodide.org/en/stable/usage/packages-in-pyodide.html. I believe the maintainer will bump the orjson version in pyodide in the future, but it would make more sense to specify the minimum version of orjson here to 3.10.1 in pyproject.toml, so this works ootb with pyodide on day 1. @Gizemdem do you think we can lower the minimum version of orjson?