mitmproxy / pdoc

API Documentation for Python Projects
https://pdoc.dev
MIT No Attribution
1.95k stars 193 forks source link

Support conda install #380

Closed jacksund closed 2 years ago

jacksund commented 2 years ago

Problem Description

Currently, pdoc is only available through pip install pdoc

Proposal

Allow installation for anaconda users via conda install -c conda-forge pdoc

Additional context

This would not require any changes to the pdoc repository.

Instead, this involves creating a conda feedstock that pulls builds from pypi. I'll assign myself as the maintainer for the feedstock repo, but welcome additions if others are interested.

jacksund commented 2 years ago

you can follow along with the feedstock creation here

jacksund commented 2 years ago

@mhils How do you upload releases to pypi? I'm not seeing a github workflow that does this or extra details in your docs. It might be worth adding a workflow like this one, which automatically uploads a new whl (and dist) to pypi each time you create a new release tag.

mhils commented 2 years ago

Releases are uploaded by CI, check out the deploy job. Can't link because on mobile :)

jacksund commented 2 years ago

Oh gotcha, I follow now. If you wanted, you could switch that custom twine job with the one I linked above. Does exactly the same thing using Twine, but also uploads a source distribution (tar.gz) to pypi as well. Having the tar.gz files on pypi would let me automate conda-forge releases.

mhils commented 2 years ago

I've manually uploaded an sdist for pdoc 11, #381 makes sure that we will do that automatically in the future. :)

jacksund commented 2 years ago

Awesome, thank you!

My feedstock request is pending review, so I'll close this issue once that goes through.

jacksund commented 2 years ago

just an update: the feedstock was approved and should be live in the next 24hrs

jacksund commented 2 years ago

Anaconda users can now install pdoc with...

conda install -c conda-forge pdoc

@mhils if you ever think a bug exists solely for conda installs (i.e. can't be reproduced with pip), send them my way.

Some helpful links:

mhils commented 2 years ago

Awesome, thank you very much! 🍰 😃