PyPI package

[Cudok]

• create package
• test upload to https://test.pypi.org
• docu of the building and upload process
• adapt bim2sim installation guide
• write test to test new PyPI packages

[Cudok]

it not possible to upload the created package to test.pypi

• Reason: there are dependencies with direct references (links to git-repos) in the pyproject.toml of bim2sim
• calling dependencies via direct references is (more or less) not possible

dependencies with direct references

• "eppy @ git+https://github.com/BIM2SIM/eppy.git#f61c070",
  • fork in bim2sim repo
  • only version requirement
  • David checks, maybe not neede anymore
• "geomeppy@git+https://github.com/BIM2SIM/geomeppy@fix_dependencies",
  • fork
  • adapt one import (is needed)
  • simple PR needed
• "OCCUtils@git+https://github.com/tpaviot/pythonocc-utils", # from base requiremts.txt
  • is not on pypi
  • developer wands to bring it to pypi, but not clear when
• "pyvis@git+https://github.com/squidKid-deluxe/pyvis@fix-show#egg=pyvis",
  • is a link of a branch including a fix
  • branch includes fix needs be merged and deployed to pypi
  • David will ask this author too, when occutils will ported to pypi

solution

• there are other solutions, like using requirements.txt, poetry and other tricks solutions, but the clear and favored solution is:
  • bring all direct references (git links) to pypi and use the pypi references
• but when this is not possible, we stay with the actual installation routine of bim2sim without using pypi

pypi challenge steps / todos

• David ask developer of OCCutils
  • short Answer: will bring it to pypi, but not clear when
• check for OCCutils pypi deployment in January of 2025 @Cudok and @DaJansenGit
• David will check if the adaption of the code of eppy is still needed
• geomeppy: simple PR of bim2sim related changes
• pyvis: David ask developer to include fix