8000 Update Makefile by ntoll · Pull Request #1793 · pyscript/pyscript · GitHub
[go: up one dir, main page]

Skip to content

Update Makefile #1793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 24, 2023
Merged

Update Makefile #1793

merged 1 commit into from
Oct 24, 2023

Conversation

ntoll
Copy link
Member
@ntoll ntoll commented Oct 9, 2023

Description

Our top level Makefile was complicated and contained cruft. This PR simplifies things so a new maintainers set-up process is simple. After discord based discussion we've dropped conda for the more widespread venv/pip way to manage Python dependencies.

PLEASE CHECK: If the Makefile is used by GitHub actions or other CI related tasks - please let me know.

Changes

This PR makes the following changes:

  • Simplify the Makefile.
  • Remove Conda (use venv/pip instead).
  • Use standard requirements.txt for Python dependencies.
  • Remove pointless type annotation from support.py.

Checklist

  • All tests pass locally
  • I have updated docs/changelog.md
  • I have created documentation for this(if applicable)

@ntoll
Copy link
Member Author
8000
ntoll commented Oct 9, 2023

OK... looks like make setup messes up. Was working fine on my home machine. I'll fix in the morning.

@JeffersGlass
Copy link
Contributor

Couple things:

  • the test workflow uses make test-integration.

run: make test-integration

  • make test-integration is also mentioned in the core's README.md:

make test-integration

@ntoll
Copy link
Member Author
ntoll commented Oct 10, 2023

Thanks @JeffersGlass, this is why it's a draft! 😄 Once merged, this change will mean our setup docs are super simple. :-) I'll update the README as part of this PR in subsequent commits. 🎉

@ntoll
Copy link
Member Author
ntoll commented Oct 10, 2023

@JeffersGlass upon refection I've retained the test-integration name because explicit is better than implicit. 🐍

@ntoll
Copy link
Member Author
ntoll commented Oct 10, 2023

Did I mention how much I hate YAML and GitHub actions? 🤣

I'll squash and take this out of draft.

@ntoll ntoll force-pushed the ntoll-simple-makefile branch from 53f7be5 to 56b1b1a Compare October 10, 2023 09:32
@ntoll ntoll marked this pull request as ready for review October 10, 2023 10:03
@ntoll ntoll requested review from fpliger and JeffersGlass October 10, 2023 14:43
@ntoll
Copy link
Member Author
ntoll commented Oct 10, 2023

OK... checking of Python versions still doesn't work. Fixing (again).

fi

# Check the environment, install the dependencies.
setup: check-node check-npm check-python
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we missing a command here to actually create the virtual environment? I see your docs PR says "Simply create a virtual environment", but in my experience that process is not necessarily simple...

If we're recommending python3 -m venv my_pyscript_dev_venv maybe we just put that in the makefile as well, either under setup or as a separate command, just to lower friction?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @JeffersGlass - good question and one that I agonised over.

On the one hand, for absolute beginners, that might be quite useful.

But on the other non-beginners or tech folk won't have too much of a problem understanding both the concept and that there are many ways to skin that cat (in the docs see here, using virtualenvmanager, pyenv, the IDE, whatever).

So I assumed technical know how and the choice to configure that aspect of one's environment oneself.

Like I said, happy to be persuaded otherwise.

@ntoll ntoll force-pushed the ntoll-simple-makefile branch from ad10f53 to 7f104fd Compare October 16, 2023 18:04
@ntoll
Copy link
Member Author
ntoll commented Oct 23, 2023

OK... I've revised in light of comments. Can we approve?

@ntoll ntoll force-pushed the ntoll-simple-makefile branch from 1fcb944 to 09221b9 Compare October 24, 2023 08:41
@ntoll ntoll merged commit 13604e0 into main Oct 24, 2023
@ntoll ntoll deleted the ntoll-simple-makefile branch October 24, 2023 08:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants
0