What is This?
I am at SciPy and I went through making a Python package with @chendaniely. This is my notes on how the Create a Python Package Tutorial worked for me. I am not familiar with Python packaging (though I am used to programming+open source contribution in general).
User Story
I was confused that copier copied the files into the current directory, instead of making a directory with the project name. Other tools I have used that create a new project create a new project directory when initializing a project template.
Yes, but with a minimal setup (Sec. 1) should reflect MINIMAL: I want a minimal setup (package, tests and docs); linting & typing not included). shown in the cli prompt. Since it's in a codeblock, I thought it would appear verbatim.
There are a few places that you are assumed to understand conda or uv, but there aren't any resources for either of them. It would be helpful to provide a resource on modern Python environments, especially for scientists/researchers. You are also assumed to know hatch, but this is earlier in the docs and linked.
It would be nice to have a "choose your setup" for different python environment tools. This might looks like a selection at the start and the shell stuff would get filled in based on your selected environment. The cli examples or hints could then match the tool you are using.
"What does python -m pip install -e do?" (Sec. 5) is helpful. I didn't know what the -e flag was doing.
Why are inline code blocks darker than block code? Some of the shell codeblocks are missing syntax highlighting (like going through the setup prompt in Sec. 1).
Might be good to show grepping pip list. The output is really long and I instinctively piped it to grep.
"Installing packages from GitHub" section should have something about dealing with GitHub and Git, maybe a link to a resource specifically targeted at scientists/researchers.
piOpenSci banner is not in the same order as described in the article. This is how it would work when packaging an existing project, rather than setting one up as a package initially. I was confused for a second that this was a different order than in the article.
What is This?
I am at SciPy and I went through making a Python package with @chendaniely. This is my notes on how the Create a Python Package Tutorial worked for me. I am not familiar with Python packaging (though I am used to programming+open source contribution in general).
User Story
I was confused that copier copied the files into the current directory, instead of making a directory with the project name. Other tools I have used that create a new project create a new project directory when initializing a project template.
Yes, but with a minimal setup(Sec. 1) should reflectMINIMAL: I want a minimal setup (package, tests and docs); linting & typing not included).shown in the cli prompt. Since it's in a codeblock, I thought it would appear verbatim.There are a few places that you are assumed to understand conda or uv, but there aren't any resources for either of them. It would be helpful to provide a resource on modern Python environments, especially for scientists/researchers. You are also assumed to know hatch, but this is earlier in the docs and linked.
It would be nice to have a "choose your setup" for different python environment tools. This might looks like a selection at the start and the shell stuff would get filled in based on your selected environment. The cli examples or hints could then match the tool you are using.
"What does python -m pip install -e do?" (Sec. 5) is helpful. I didn't know what the
-eflag was doing.Why are inline code blocks darker than block code? Some of the shell codeblocks are missing syntax highlighting (like going through the setup prompt in Sec. 1).
Might be good to show grepping
pip list. The output is really long and I instinctively piped it to grep."Installing packages from GitHub" section should have something about dealing with GitHub and Git, maybe a link to a resource specifically targeted at scientists/researchers.
piOpenSci banner is not in the same order as described in the article. This is how it would work when packaging an existing project, rather than setting one up as a package initially. I was confused for a second that this was a different order than in the article.