search

AThePeanut4 / docify

A script to add docstrings to Python type stubs using reflection
MIT License
10 stars 2 forks source link

publish on pypi #3

Closed DetachHead closed 2 months ago

DetachHead commented 3 months ago

this would make it easier to depend on this script as part of my project. i can make a PR for this if you want

AThePeanut4 commented 3 months ago

Yeah I do plan on doing that, need to first figure out how Python packaging works lol

There's also already a package on PyPI called Docify (https://pypi.org/project/Docify), which is luckily abandoned so it seems like I should be able to get the name transferred - that could potentially take a while though.

jorenham commented 3 months ago

This lack of a pyproject.toml appears to be causing the basedpyright==1.13.0 pre-commit hook to fail: https://github.com/DetachHead/basedpyright/issues/430

Note that this could be solved without publishing to pypi; having a pyproject.toml would be sufficient in this case.

AThePeanut4 commented 3 months ago

I've added a pyproject.toml, still busy figuring out the best way to package/build/etc. I will publish on PyPI once that's worked out.

I have also been able to get the project name transferred over, so that issue is resolved.

@DetachHead Just FYI I changed the method signature for main to make it work with the project.scripts key, so you'll need to change the usage in basedpyright, or use run.

DetachHead commented 3 months ago

I've added a pyproject.toml, still busy figuring out the best way to package/build/etc. I will publish on PyPI once that's worked out.

if you want my opinion, pdm with pyprojectx has given me the least painful experience managing a python project. publishing is quite easy especially when you use the trusted publisher feature. (pyprojectx isn't needed, but it makes it much easier for potential contributors to get set up for local development)

AThePeanut4 commented 2 months ago

All done: https://pypi.org/project/docify