Skip to content
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

PyPI: make alpha release? #4

Closed
agoose77 opened this issue May 26, 2021 · 16 comments
Closed

PyPI: make alpha release? #4

agoose77 opened this issue May 26, 2021 · 16 comments

Comments

@agoose77
Copy link
Collaborator

This issue is to track the release of this package on NPM and PyPI. We should release an alpha at some point. Currently the PyPI package for jupyter-book sits under @choldgraf, but I'm also happy to release it under my account if it helps share the maintenance burden.

@welcome
Copy link

welcome bot commented May 26, 2021

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

@choldgraf
Copy link

+1 from me on making a release.

Do you know if there's a way to have a generic "organizational account" on PyPI? Or does it have to be attached to a specific person?

If the latter, I'm happy to just create one and add you all as admins on it. I think it's probably easier to keep track of "admin ownership status" if there are fewer unique owners across the EBP packages.

@agoose77
Copy link
Collaborator Author

From what I can see, organisational accounts are a planned but as-yet unrealised feature of PyPI. So I think your proposal is the best way forward here!

@chrisjsewell
Copy link

Do you know if there's a way to have a generic "organizational account" on PyPI? Or does it have to be attached to a specific person?

this is why we have @ebp-bot, https://pypi.org/user/ebp-bot/

@agoose77
Copy link
Collaborator Author

this is why we have @ebp-bot, https://pypi.org/user/ebp-bot/

So, is this user just used for releasing via CI?

@chrisjsewell
Copy link

Just as a central account for adding PyPI maintenance etc, then you just generate an API Keys for releases as done in our other packages, e.g. https://github.com/executablebooks/sphinx-external-toc/blob/5f0cbdc568580875d5909a3de967c1963b7f858e/.github/workflows/tests.yml#L61

@choldgraf
Copy link

I opened up an issue to document the ebp-bot here, let me know if I missed something: executablebooks/team-compass#10

@Pugio
Copy link

Pugio commented Jan 14, 2022

Hi, what's the current status of releasing this? I would really love advanced Markdown support in my lab notebooks.
Is there anything I can do to help move this along? I'm happy to help...

@agoose77
Copy link
Collaborator Author

@chrisjsewell @choldgraf I'm now strongly considering using jupyter book for my PhD thesis, so I could afford to take a bit of time to update the extension. I've taken the liberty of bundling the style from markdown-it-myst/myst.css (after prepending the jupyterlab markdown selector) and releasing on PyPI 0.1.1.

In the long run, I am fully aware that we want this package to be published by the EB team, with the suggestion of using the ebp-bot. I can transfer ownership at a future time when we've set this up?

I would like to request some kind of admin rights on this repo so that I can merge PRs etc. Let me know if this is something you're amenable to?

@choldgraf
Copy link

@agoose77 - you've done much of the work in this repository already, and we've appreciated all of your contributions here (and elsewhere) over the months. I think you certainly deserve maintainer status. I've given you maintain rights to this repo 👍

@agoose77
Copy link
Collaborator Author

Fab, that was very quick - thanks!

@chrisjsewell
Copy link

chrisjsewell commented Jan 19, 2022

Hey, @agoose77, yeh all help welcome thanks! (wanted also to circle round to chatting with you about the inline execution stuff)

So currently, this package pulls from markdown-it-myst, but actually that's not the most up-to-date at present. I/We have been working on https://executablebooks.github.io/markdown-it-docutils/, which is a lot more powerful.

That package, and a few others, are used directly in: https://github.com/executablebooks/myst-vs-code/blob/master/src/extension.ts, to create https://marketplace.visualstudio.com/items?itemName=ExecutableBookProject.myst-highlight.

Ideally, the code in myst-vs-code would be "centralised" into an update to markdown-it-myst, and then essentially the VS Code extension and JupyterLab extension would very closely mirror each other (or indeed any other JavaScript implementation)

@agoose77
Copy link
Collaborator Author

Hey @chrisjsewell, thanks for the update. It seems at first glance that this is the directive-logic factored out into its own markdown-it plugin? Is the idea then that markdown-it-myst is just a meta-plugin that bundles this (and other non executable-books plugins) into a single .use() invocation?

@choldgraf
Copy link

choldgraf commented Jan 19, 2022

I opened up #14 to track this. Not sure if I missed some important context or step there, so feel free to update it with the correct information

@chrisjsewell
Copy link

Is the idea then that markdown-it-myst is just a meta-plugin that bundles this (and other non executable-books plugins) into a single .use() invocation?

pretty much yeh 👍

@agoose77
Copy link
Collaborator Author

OK. I'm going to close this issue then, because we do "have" a release on PyPI. I'll continue this discussion in executablebooks/MyST-Parser#65?

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

No branches or pull requests

4 participants