Add task definitions for just as alternative command runner #127

dalito · 2025-01-07T23:50:13Z

Adds a justfile with tasks for the just command runner.

The added commands should match the current makefile. While working on this I slightly simplified the makefile/config, e.g. to use cookiecutter-parameters / env.vars more consistent.

Closes #120

sierra-moxon · 2025-01-08T16:17:35Z

{{cookiecutter.project_name}}/config.yaml

@@ -22,6 +22,8 @@ generator_args:
    mergeimports: true
  jsonldcontext:
    mergeimports: true
+  pydantic:
+    mergeimports: true


@dalito - can you confirm that this addition does not result in the pydantic version of the python serialization being generated automatically for new projects and overwriting the already generated dataclasses serialization? We definitely want to move to pydantic being the default python serialization eventually.

Would it be OK to generate both standard python and pydantic? I have to try it out to be sure.

a couple of repos I'm aware of do that, yep (renaming the pydantic file to something different from the dataclasses version e.g.: https://github.com/biolink/biolink-model/blob/fe44b8d56b7a1e77fb1e94f78a143dddb8681565/Makefile#L127 -- the naming is kind of awkward but I bet we could come up with something more reasonable here).

but, it might be that we just want to split this change out from this PR? I will leave that to your judgment.

I removed this change.

{{cookiecutter.project_name}}/justfile

sierra-moxon

I am not an expert at just - but I imagine the impetus for this PR is to help Windows users set up a functional project more easily?

I imagine for a new user it would be helpful to have a few more pointers on which to use: make or just (though I see good comments in the README about using just, in particular, for windows users).

Thank you for working all this out! its terrific :)

amc-corey-cox

I'm generally in approval here for making things easier for people to develop on Windows. Unfortunately, I do have significant concerns about this opening new projects to having command runners out of sync. Can you discuss how we can mange this to avoid make and just acting differently over time in a new repo?

amc-corey-cox · 2025-01-08T17:08:21Z

README.md

+
+  * **make or just as command runner**
+
+    The project contains a makefile but also a `justfile` with pre-defined complex commands. To execute these commands you either need `make` or [just](https://github.com/casey/just) as an alternative command runner. Especially for Windows users we suggest `just`. Install it by running:


I'm a little concerned about having two command runners requiring changes in two places and the possibility of their getting out of sync. Do you have a strategy for managing both of these files to avoid that?

Yes. I agree that having both is not ideal but may be worth an experiment. Some make users may also convert to just but it is difficult to predict.

amc-corey-cox · 2025-01-08T17:12:15Z

{{cookiecutter.project_name}}/justfile

+# Load environment variables from config.public.mk or specified file
+set dotenv-load := true
+# set dotenv-filename := env_var_or_default("LINKML_ENVIRONMENT_FILENAME", "config.public.mk")
+set dotenv-filename := x'${LINKML_ENVIRONMENT_FILENAME:-config.public.mk}'


Ah, you do import the make config here. Maybe my concern about two files is moot?

Yes it reads from the same file as the make file. Only the tasks are defined again the just-way.

amc-corey-cox · 2025-01-08T17:15:40Z

{{cookiecutter.project_name}}/justfile

+site: _gen-project _gendoc
+
+# Deploy site
+deploy: site


Hmm, these do look like recreations of the same things in our Makefile. Or am I misunderstanding? Does just play nice with make or do we have two command runners with their own configs?

Two runners, one config.

dalito · 2025-01-08T22:13:12Z

@sierra-moxon - I saw that you merged main into this (my) branch. Typically as an author that contributes from a fork, I would just rebase on current upstream main to get the latest changes and then force-push to update this PR. I think the reason why most projects prefer rebasing the PRs is the cleaner git history.

It would be great to merge #128 before this PR. Afterwards I would like to do a final check of all just commands in a Poetry 2.0 based project.

sierra-moxon · 2025-01-10T22:11:59Z

from dev call: consider pulling this functionality up one level, making code to create a justfile out of a makefile? or otherwise moving build system management back into python and away from make or just? (see ticket linked in this PR, probably hold off on merge until feedback from @dalito)

dalito · 2025-01-11T01:42:15Z

@sierra-moxon Thanks for the feedback from the dev call. Even if I created this PR I am also not convinced that another task runner is a good solution.

The main disadvantage of this PR is that it still requires access to bash (or sh) which comes with git-for-windows but needs to be put on path. Such small steps are often a hurdle for beginners. Something to note is that just can use other shells as well, e.g. powershell, but then the recipes would be platform-specific. It can also run commands in a Python shell which could solve the bash-shell-config issue. Here I tried to write the justfile makefile-alike for easy comparison. However, it would also be possible to write a justfile using python recipes.

To leave the code here in proper state, I did a fresh rebase and checked that the justfile commands actually work.

What I also recognized: The makefile expects a non-standard dotenv file (no quotes around strings) but just expects a standard-compliant dotenv file with quotes around strings with spaces. So just and make cannot use exactly the same dotenv config file. This is another argument against merging this PR (although the problem is make not just).

moving build system management back into python

Then I suggest to either
a) close this PR and work towards this "more in Python" goal or
b) merge it as "experimental" feature without long-term guarantees to gather feedback.

For b) the makefile should be made to work with standard dotenv files first to avoid incompatible configs. The incompatibility was introduced in #123 to work-around make problems.

sierra-moxon requested review from sierra-moxon and amc-corey-cox January 8, 2025 16:07

sierra-moxon reviewed Jan 8, 2025

View reviewed changes

{{cookiecutter.project_name}}/justfile Show resolved Hide resolved

sierra-moxon approved these changes Jan 8, 2025

View reviewed changes

amc-corey-cox approved these changes Jan 8, 2025

View reviewed changes

dalito force-pushed the issue120-just branch from 46f281c to 18268d0 Compare January 11, 2025 00:28

dalito added 6 commits January 11, 2025 02:49

Simplify makefile and config

340158e

Add a justfile matching the make commands

e123584

Update READMEs for just

82fae5e

Don't parse justfile with cookiecutter

d20d919

Quote values in dotenv file

239051f

Fixes after testing all commands

846de57

dalito force-pushed the issue120-just branch from 4c0f2a1 to 846de57 Compare January 11, 2025 01:50

fixup! Simplify makefile and config

3eb2522

dalito mentioned this pull request Jan 11, 2025

Alternative command runner to make (tasks/just/duty) #120

Open

Fix pipx install command for just

ed1ceb5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add task definitions for just as alternative command runner #127

Add task definitions for just as alternative command runner #127

dalito commented Jan 7, 2025 •

edited

Loading

sierra-moxon Jan 8, 2025

dalito Jan 8, 2025

sierra-moxon Jan 8, 2025

dalito Jan 11, 2025

sierra-moxon left a comment •

edited

Loading

amc-corey-cox left a comment

amc-corey-cox Jan 8, 2025

dalito Jan 8, 2025 •

edited

Loading

amc-corey-cox Jan 8, 2025

dalito Jan 8, 2025

amc-corey-cox Jan 8, 2025

dalito Jan 8, 2025

dalito commented Jan 8, 2025

sierra-moxon commented Jan 10, 2025 •

edited

Loading

dalito commented Jan 11, 2025 •

edited

Loading


		* make or just as command runner

		The project contains a makefile but also a `justfile` with pre-defined complex commands. To execute these commands you either need `make` or [just](https://github.com/casey/just) as an alternative command runner. Especially for Windows users we suggest `just`. Install it by running:

Add task definitions for just as alternative command runner #127

Are you sure you want to change the base?

Add task definitions for just as alternative command runner #127

Conversation

dalito commented Jan 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sierra-moxon left a comment • edited Loading

Choose a reason for hiding this comment

amc-corey-cox left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dalito Jan 8, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dalito commented Jan 8, 2025

sierra-moxon commented Jan 10, 2025 • edited Loading

dalito commented Jan 11, 2025 • edited Loading

dalito commented Jan 7, 2025 •

edited

Loading

sierra-moxon left a comment •

edited

Loading

dalito Jan 8, 2025 •

edited

Loading

sierra-moxon commented Jan 10, 2025 •

edited

Loading

dalito commented Jan 11, 2025 •

edited

Loading