Billingegroup / bg-mpl-stylesheets

Matplotlib style sheets
Other
2 stars 25 forks source link

release the package to conda-forge #10

Closed dragonyanglong closed 6 months ago

dragonyanglong commented 3 years ago

Hi @st3107 , @sbillinge would like to publish this group plot style to conda-forge, so that everyone can simply install the package from there. can you help with it? or instruct me how to do that?

BTW, @sbillinge , would you like to give a better name for the package? Currently, it would be like

from billinge_style.bg_plt_style import bg_plt_style
sbillinge commented 3 years ago

I think the name is ok. Sufficiently distinct that it won't overlap with others, but short and clear. Let's go with this.

On Fri, Oct 30, 2020 at 1:31 AM longyang notifications@github.com wrote:

Hi @st3107 https://github.com/st3107 , @sbillinge https://github.com/sbillinge would like to publish this group plot style to conda-forge, so that everyone can simply install the package from there. can you help with it? or instruct me how to do that?

BTW, @sbillinge https://github.com/sbillinge , would you like to give a better name for the package? Currently, it would be like

from billinge_style.bg_plt_style import bg_plt_style

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Billingegroup/mpl-stylesheets/issues/10, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABAOWUMJNLTVZR5BF2AT5VLSNJFUDANCNFSM4TESF5NA .

-- Simon Billinge Professor, Columbia University Physicist, Brookhaven National Laboratory

st3107 commented 3 years ago

Here is the instruction.

https://conda-forge.org/#add_recipe

If you have made a conda recipe before, it will be quick. If not please take a look at the conda recipe introduction.

https://docs.conda.io/projects/conda-build/en/latest/concepts/recipe.html

On Fri, Oct 30, 2020 at 1:31 AM longyang notifications@github.com wrote:

Hi @st3107 https://github.com/st3107 , @sbillinge https://github.com/sbillinge would like to publish this group plot style to conda-forge, so that everyone can simply install the package from there. can you help with it? or instruct me how to do that?

BTW, @sbillinge https://github.com/sbillinge , would you like to give a better name for the package? Currently, it would be like

from billinge_style.bg_plt_style import bg_plt_style

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Billingegroup/mpl-stylesheets/issues/10, or unsubscribe https://github.com/notifications/unsubscribe-auth/AI27NDY7WI5SC5PHFTZXSWDSNJFTZANCNFSM4TESF5NA .

-- [image: photo] Songsheng Tao Ph. D. student, Columbia University

347-749-7947 Create your own email signature https://www.wisestamp.com/create-own-signature/?utm_source=promotion&utm_medium=signature&utm_campaign=create_your_own&srcid=

dragonyanglong commented 3 years ago

Hi @st3107 , do you have any example repo that I can refer to? It looks like quite complicated from the instruction...

st3107 commented 3 years ago

Yes. There are examples:

https://github.com/conda-forge/xpdtools-feedstock

Actually, what you need to do is to write a meta.yaml

https://github.com/conda-forge/xpdtools-feedstock/blob/master/recipe/meta.yaml

All other files are generated automatically by running conda-smithy.

On Fri, Oct 30, 2020 at 10:08 AM longyang notifications@github.com wrote:

Hi @st3107 https://github.com/st3107 , do you have any example repo that I can refer to? It looks like quite complicated from the instruction...

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Billingegroup/mpl-stylesheets/issues/10#issuecomment-719573597, or unsubscribe https://github.com/notifications/unsubscribe-auth/AI27NDZ3BEKKRADIOXPKUBDSNLCFXANCNFSM4TESF5NA .

-- [image: photo] Songsheng Tao Ph. D. student, Columbia University

347-749-7947 Create your own email signature https://www.wisestamp.com/create-own-signature/?utm_source=promotion&utm_medium=signature&utm_campaign=create_your_own&srcid=

dragonyanglong commented 3 years ago

BTW, do you know how to wrap the github repo into a .tar.gz, which looks like is required by conda release.

st3107 commented 3 years ago

I guess that you probably like a simpler solution. I suggest releasing on pip. You just need to run twine. Or you can consider the diffpy channel on conda which is the channel of our group.

For diffpy channel, you just need to make a meta.yaml file and run ``conda build```

Sincerely, Songsheng

On Fri, Oct 30, 2020 at 10:25 AM longyang notifications@github.com wrote:

BTW, do you know how to wrap the github repo into a .tar.gz, which looks like is required by conda release.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Billingegroup/mpl-stylesheets/issues/10#issuecomment-719583067, or unsubscribe https://github.com/notifications/unsubscribe-auth/AI27ND3E4AVL3UJR42ZOSRDSNLEEXANCNFSM4TESF5NA .

-- [image: photo] Songsheng Tao Ph. D. student, Columbia University

347-749-7947 Create your own email signature https://www.wisestamp.com/create-own-signature/?utm_source=promotion&utm_medium=signature&utm_campaign=create_your_own&srcid=

dragonyanglong commented 3 years ago

@sbillinge , how do you think? release to conda-forge, pip, or conda/diffpy channel?

@st3107 , thanks! BTW, for creating the .tar.gz file for the package github repo, is that simply click the "release" button on the github website?

dragonyanglong commented 3 years ago

@sbillinge , I probably need higher permission on this repo I think, to release a package version?

st3107 commented 3 years ago

Sorry that I don't know. I use rever for these in my own packages and CJ's packages. The releasing is done by rever according to a xonsh script so I didn't know how it is operated on github and you probably need to ask google.

The most simple release for your package is to release on the github and do a pip release. Then, our group member can do a pip install.

On Fri, Oct 30, 2020 at 10:55 AM longyang notifications@github.com wrote:

@sbillinge https://github.com/sbillinge , how do you think? release to conda-forge, pip, or conda/diffpy channel?

@st3107 https://github.com/st3107 , thanks! BTW, for creating the .tar.gz file for the package github repo, is that simply click the "release" button on the github website?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Billingegroup/mpl-stylesheets/issues/10#issuecomment-719601045, or unsubscribe https://github.com/notifications/unsubscribe-auth/AI27ND7YVNQST4JGREKDIVTSNLHVXANCNFSM4TESF5NA .

-- [image: photo] Songsheng Tao Ph. D. student, Columbia University

347-749-7947 Create your own email signature https://www.wisestamp.com/create-own-signature/?utm_source=promotion&utm_medium=signature&utm_campaign=create_your_own&srcid=

dragonyanglong commented 3 years ago

Can you share the rever xonsh release script with me, for a public git repo, like your xpdtools maybe?

sbillinge commented 3 years ago

Can you use the one in Regolith maybe?

On Fri, Oct 30, 2020, 10:01 PM longyang notifications@github.com wrote:

Can you share the rever xonsh release script with me, for a public git repo, like your xpdtools maybe?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Billingegroup/mpl-stylesheets/issues/10#issuecomment-719868359, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABAOWUIUCPWM5AQZ7ORMLVLSNNVWJANCNFSM4TESF5NA .

dragonyanglong commented 3 years ago

Hi @st3107 , I have made the recipe for this package at https://github.com/dragonyanglong/mpl-stylesheets/tree/add_conda/recipe? How to make sure if it is working?

If we release to conda-forge, is the meta.yaml the only required file? It seems like conda-smithy can only be run when creating a new repo?

st3107 commented 3 years ago

To release on the conda-forge, please look at the instructions:

https://conda-forge.org/docs/maintainer/adding_pkgs.html#step-by-step-instructions

Basically the workflow is:

  1. Submit a PR to the conda-forge

  2. conda-forge review your PR and create a feedstock repo for you

  3. you put the meta.yaml into the repo in a folder "recipe" and run conda-smithy and then submit a PR

  4. the robot of conda-forge will automatically check if a package can be built according to the recipe

  5. If success, the PR will be merged and then the robot will build and publish the package to conda-forge channel on conda

How does the rever help here?

The rever can do the step 3 for you. It can download the feed-stock, run conda-smithy and submit PR.

It may sound a little troublesome but actually it will only be done once and for all. After that, it will just be run rever for the updates of the feed-stock.

I didn't do this before because CJ has already done this for his repos and my package pdfstream is released on diffpy. If you would like to see how it is done for diffpy or other non-forge style channels. Here is my example.

https://github.com/st3107/pdfstream

I use the release.py to build the meta.yaml and use rever to run conda-build.

On Sun, Nov 1, 2020 at 4:40 AM longyang notifications@github.com wrote:

Hi @st3107 https://github.com/st3107 , I have made the recipe for this package at https://github.com/dragonyanglong/mpl-stylesheets/tree/add_conda/recipe? How to make sure if it is working?

If we release to conda-forge, is the meta.yaml the only required file? It seems like conda-smithy can only be run when creating a new repo?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Billingegroup/mpl-stylesheets/issues/10#issuecomment-720060970, or unsubscribe https://github.com/notifications/unsubscribe-auth/AI27ND44VCPELXXD42LOOZTSNUUJDANCNFSM4TESF5NA .

-- [image: photo] Songsheng Tao Ph. D. student, Columbia University

347-749-7947 Create your own email signature https://www.wisestamp.com/create-own-signature/?utm_source=promotion&utm_medium=signature&utm_campaign=create_your_own&srcid=

connorjbracy commented 2 years ago

This should be closed now, right? bg-mpl-stylesheets conda forge package conda-forge/bg-mpl-stylesheets-feedstock

sbillinge commented 2 years ago

not sure. I am having trouble releasing the new version to conda forge.....

On Wed, Oct 27, 2021 at 9:11 AM Connor J. Bracy @.***> wrote:

This should be closed now, right? conda forge package https://anaconda.org/conda-forge/bg-mpl-stylesheets conda forge feedstock https://github.com/conda-forge/bg-mpl-stylesheets-feedstock

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Billingegroup/bg-mpl-stylesheets/issues/10#issuecomment-952913089, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABAOWUMR6SHAGKKG4M5SMOTUI727HANCNFSM4TESF5NA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

-- Simon Billinge Professor, Columbia University Physicist, Brookhaven National Laboratory

sbillinge commented 2 years ago

wait, give me a minute, the check just worked after I installed conda-smithy in my env..... I will run it without -c now....

On Wed, Oct 27, 2021 at 9:13 AM Simon Billinge @.***> wrote:

not sure. I am having trouble releasing the new version to conda forge.....

On Wed, Oct 27, 2021 at 9:11 AM Connor J. Bracy @.***> wrote:

This should be closed now, right? conda forge package https://anaconda.org/conda-forge/bg-mpl-stylesheets conda forge feedstock https://github.com/conda-forge/bg-mpl-stylesheets-feedstock

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Billingegroup/bg-mpl-stylesheets/issues/10#issuecomment-952913089, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABAOWUMR6SHAGKKG4M5SMOTUI727HANCNFSM4TESF5NA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

-- Simon Billinge Professor, Columbia University Physicist, Brookhaven National Laboratory

-- Simon Billinge Professor, Columbia University Physicist, Brookhaven National Laboratory