Skip to content

Remove travis-ci, split README/CONTRIBUTING #353

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 19 commits into from
Feb 24, 2021

Conversation

bollwyvl
Copy link
Contributor

@bollwyvl bollwyvl commented Feb 22, 2021

So long, travis, thanks for all the builds!

This PR:

  • removes the travis build config
  • splits CONTRIBUTING and README
    • README
      • adds link to LICENSE
      • add badges for PyPI and conda-forge
      • add new ci badges
      • add binder badge
    • CONTRIBUTING
      • adds Code of Conduct link
      • expand with more development tasks
  • binder (preview)
    • move environment.yml to .binder folder
    • add rest of (declared) example dependencies
    • make it a "hot" binder, with current in-repo stuff
    • build docs in binder
  • add README to package so pypi isn't so empty
  • update license years/holders
    • @jasongrout as the current copyright holder, how do you feel about normalizing the license text, etc. with what's in ipywidgets

Not on this PR:

  • updating the sphinx install docs
    • maybe pull in the README and CONTRIBUTING in, rather than reproducing it in rst

@codecov-io
Copy link

codecov-io commented Feb 22, 2021

Codecov Report

Merging #353 (701b3ea) into master (9c38c20) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #353   +/-   ##
=======================================
  Coverage   70.86%   70.86%           
=======================================
  Files          23       23           
  Lines         834      834           
=======================================
  Hits          591      591           
  Misses        243      243           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9c38c20...701b3ea. Read the comment docs.

jupyter labextension develop . --overwrite
popd
python setup.py sdist
python -m pip install -v dist/pythreejs*.tar.gz --no-deps --ignore-installed
Copy link
Member

@vidartf vidartf Feb 22, 2021

Choose a reason for hiding this comment

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

Does this not cause a new build when installing from the sdist? It might be more optimal to install via wheel?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it probably does... i'm more interested in robust than optimal, and frankly care more about what makes it to the (intermediate) .tar.gz than the .whl... but faster is of course better. will try a few more things...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

--no-build-isolation saves a some stuff (e.g recompiling pyrsistent and pandocfilters).

Unfortunately, the way --skip-npm is passed down, if you have node, it's going to rebuild... perhaps optionally checking a PYTHREEJS_SKIP_NPM would be more robust. Or if the stale check worked...

Copy link
Member

Choose a reason for hiding this comment

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

To be clear, my suggestion was to use python setup.py bdist_wheel and then pip install using the wheel. That should do what you want while still avoiding rebuilds, right ?

Copy link
Member

Choose a reason for hiding this comment

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

(if you are saying this is meant to be a test of the sdist install, that is probably different).

@bollwyvl
Copy link
Contributor Author

bollwyvl commented Feb 22, 2021

I think this is about as good as I can get the simple docs and binder working for now. Probably some more issues are needed, but this would probably generate some pretty good packages at this point, modulo updating the LICENSE information.

js/README.md Outdated
```bash
yarn add jupyter-threejs
jlpm add jupyter-threejs
```
Copy link
Member

Choose a reason for hiding this comment

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

The npm/yarn/jlpm add command is not a dev install prerequisite. I believe the previous bit here was also not very helpful, so it is probably best to delete all of it and just link to the contributing document.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

cool.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Tuned that up, and added the LICENSE so that it gets included in the npm distribution (and all the other places).

Copy link
Contributor Author

@bollwyvl bollwyvl Feb 24, 2021

Choose a reason for hiding this comment

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

also, of note: there's no .npmignore or files in package.json, so... a lot of stuff gets into the tarball (scripts, src, the linter config, the lab dist tarball, etc). that could probably be tuned up...

Copy link
Member

Choose a reason for hiding this comment

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

Good point, I'll have a look at cleaning up the tarball.

@vidartf
Copy link
Member

vidartf commented Feb 24, 2021

Merging as is, will iterate on the tarball and then do the release.

@vidartf vidartf merged commit e595deb into jupyter-widgets:master Feb 24, 2021
@bollwyvl
Copy link
Contributor Author

Gave the binder a shake, looking good.

Now in badgetopia, we're just down to docs... will have a look...

@vidartf vidartf mentioned this pull request Feb 25, 2021
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.

3 participants