search

vnegnev / marcos_client

Client (GUI and command-line interfaces) for MaRCoS
GNU General Public License v3.0
11 stars 15 forks source link

Make this a python project #12

Open M4a1x opened 1 year ago

M4a1x commented 1 year ago

Trying out the tutorial (well written btw!) and playing with creating my own sequences I noticed that this probably could be (and maybe should be?) a Python project (or package). This goes in the same direction as #8 and would enable users to simply import the package. Maybe even upload it to the Python Package Index (PyPI).

My suggestion would be to use the relatively new official project structure used by e.g. the official project management tool hatch from Python Packaging Authority (PyPA) that also manages e.g. pip. This would also enable easy installation in a virtual environment (e.g. Python venv)

The commands (like test_model or plot_csv) could then become so-called "console scripts" and would simply be called directly from the command line.

If you're interested in me poking around I'd be happy to help and create a PR implementing the above.

Cheers!

M4a1x commented 1 year ago

I started with some restructuring here: https://github.com/M4a1x/marcos_client I'm trying to just restructure the code and not touch any of the internals, but I haven't fully understood everything yet. I'm currently only trying to make the stuff in the readme and the wiki tutorial work and implement a simple enough CLI.

Any comments welcome!