Skip to content

Add codespaces configuration #26137

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
Jun 16, 2023
Merged

Conversation

melissawm
Copy link
Member

@melissawm melissawm commented Jun 16, 2023

PR summary

This pull request adds a GitHub codespaces configuration for Matplotlib. With this PR, contributors can open a pre-configured development environment and get started with contributing to Matplotlib right away from their browser. I'm not sure if you can test it as it is, as I believe this needs to be merged to main before anyone is able to open a codespace from the Matplotlib repo.

Once this is merged, it will enable users to go to matplotlib/matplotlib or their own fork and choose "Create codespaces on <branch>":
Screenshot_20230616_155713

This will open a browser window with a VSCode interface and a pre installed development environment built over an Ubuntu image. Users can then do

$ conda activate mpl-dev
$ python -m pip install -e .

After that you can run tests, build the documentation and run other commands.

This configuration also includes a lightweight fluxbox environment

To be done in a follow-up: documentation on how to use it and current features (like connecting to the fluxbox desktop to see plots).

PR checklist

@melissawm
Copy link
Member Author

Argh, sorry I've messed up the labels.

@jklymak
Copy link
Member

jklymak commented Jun 16, 2023

I'd be happy to merge just so you can make progress testing it in situ, with the understanding you will keep an eye on it and field questions in the unlikely event someone jumps on this before it's fully baked.

@melissawm
Copy link
Member Author

That's the plan, I'd also like to get some feedback from potential users on the configuration and I'll be also drafting the docs in the meantime.

@jklymak jklymak merged commit 083b1a0 into matplotlib:main Jun 16, 2023
@jklymak
Copy link
Member

jklymak commented Jun 16, 2023

I see this was already approved. I think for infrastructure things like this it's ok for one review at least until it's in wide use. Particularly as we all were ok with doing this in principal.

@tacaswell
Copy link
Member

This is mind-blowingly good!

How to getflux box up needs a bit of documentation.

If we can not auto-activate the right conda env, we should drop a /etc/issue to print out instructions to do that (and a link to fluxbox docs).

Lets see if I can do this from inside a codespace....

@QuLogic QuLogic added this to the v3.8.0 milestone Jun 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants