beeldengeluid / dane-example-worker

MIT License
0 stars 0 forks source link

Setup #1

Closed Veldhoen closed 4 months ago

Veldhoen commented 4 months ago

Created example worker, with all the real processing stripped away.

After creating a Poetry virtual environment, running poetry run python worker.py --run-test-file should not yield errors and should create a folder data/output-files containing both provenance and 'foobar' for a dummy run.

Besides from this working, I'd like to hear what is clear and unclear about the setup. (where) should we add more comments/descriptions in the code? We may also create a Wiki with more explanation/documentation, although that is more susceptible for getting out of sync with new versions/approaches.

Still to do (in new branch): setup testing, containerization etc.

greenw0lf commented 4 months ago

There's a lot of lines of code to read through, so it might take a while for me

But what I can say from now on is that maybe it would be useful to have an order of things to do/files to create

For example, we start with setting up Poetry, then setting up its venv and generating the pyproject.toml + poetry.lock files. After that, what would be the next step? I will read the files in the order that GitHub shows them for now.

KleinRana commented 4 months ago

It would be nice and informative to add docstrings to all functions.

KleinRana commented 4 months ago

It would be helpfull to add some text to the readme with the goal of this repo and some helpfull links.