8000 README and getting started updates by msaroufim · Pull Request #72 · pyscript/pyscript · GitHub
[go: up one dir, main page]

Skip to content

README and getting started updates #72

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 4 commits into from
May 3, 2022
Merged

Conversation

msaroufim
Copy link
Contributor
@msaroufim msaroufim commented Apr 30, 2022

Thank you for such an amazing library, made some minor fixes after going through the library today to clarify

  • GETTING STARTED link on main README
  • How to add custom dependencies, how to link against wheel files on disk
  • How to ask for dependencies that are not pure python
  • Clarified npm version otherwise on ubuntu 18.04 it was defaulting to npm version 12 and not really working

@stonebig
Copy link
stonebig commented Apr 30, 2022

npm version >= 16 ... didn't you mean nodejs version >=16 ?

on my no too old installation:

[Nodejs](https://nodejs.org) | v16.14.2 | a JavaScript runtime built on Chrome's V8 JavaScript engine
[npmjs](https://www.npmjs.com/) | 8.5.0 | a package manager for JavaScript

@fpliger fpliger added status: ready PR that is ready for review tag: docs Related to the documentation labels May 1, 2022
@fpliger
Copy link
Contributor
fpliger commented May 1, 2022

@msaroufim thank you so much for the PR! It's conflicting with the latest changes added in the meantime. Do you mind merging main and fixing the conflicts?

@msaroufim
Copy link
Contributor Author

@fpliger done! Thank you for the quick review

</py-env>
```

If your `.whl` is not a pure Python wheel then open a PR or issue with [pyodide](https://github.com/pyodide/pyodide) to get it added here https://github.com/pyodide/pyodide/tree/main/packages
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure this is the expectations from the Pyodide team. @rth @hoodmane, what do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, that's OK. We are trying to make this easier but for now, that's indeed what one has to do.

Copy link
Contributor
@hoodmane hoodmane May 2, 2022

Choose a reason for hiding this comment

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

Opening a PR or issue on the Pyodide issue tracker is good advice. It might be worth commenting that if there is popular demand from 3+ different users the Pyodide team is likely to work on porting the package, if we haven't received that much interest yet you will have to write your own PR. In any case, things will be faster if you work on a PR. We like to collaborate with newcomers on ports (we may provide advice, help you if you get stuck, and or step in and work on it ourselves if it turns out it's hard in an interesting way).

Our build system has improved quite a lot but there are still a few warts that need to be ironed out. The biggest thing is sysconfig, but cross builds are hard and distutils does not support them well.

We are also working towards out of tree builds but unfortunately they aren't ready yet.

Copy link
Contributor Author
@msaroufim msaroufim May 2, 2022

Choose a reason for hiding this comment

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

Just clarified the language in the PR. @fpliger this should be ready to merge now

Copy link
Contributor
@fpliger fpliger left a comment

Choose a reason for hiding this comment

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

thanks for the PR and the patience @msaroufim !

@fpliger fpliger merged commit 378e3ef into pyscript:main May 3, 2022
@msaroufim msaroufim deleted the docs branch May 3, 2022 23:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: ready PR that is ready for review tag: docs Related to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants
0