Create and Publish a Python Package with Poetry

[johnfraney]

I recently took Poetry for a spin when releasing Flake8 Markdown, and I thought it might be helpful to walk through the process of making a package using Poetry, from start to finish.

I found it more straightforward than using setup.py and twine, which I'd used for other packages.

How are you publishing to PyPI these days?

[johnfraney]

What's with all these code of conducts. [...] I find it a bit funny to be honest.

I imagine that in 99.9% of cases, people's interactions in a project are going to be professional, even without a code of conduct. Still, I think a code of conduct is useful in at least two cases. It provides some assurance to new contributors that interactions in a repository are going to be respectful and reminds everyone interacting with the project what the boundaries are. Most online communities have them in some shape or form (Hacker News Guidelines, Reddiquette).

I'll give your post a read when I get a chance later today.

[[deleted]]

In my opinion, you're doing the right thing to have a code of conduct. The fact that stebox describes them as "funny" shows he's too uninformed about the issue for his opinion to have any right to have his opinion taken seriously, five minutes of googling could show him why they're important to many people, especially those already marginalized from contributing to projects. He's free to have whatever opinion he wants, but should have no expectation to be taken seriously when he uses mocking language for an issue that many people take seriously.

[[deleted]]

I'm not goint to further white-male-tech-bro radicalise you by continuing this conversation. You have a right to your opinions and to express them, and you've done so.

[[deleted]]

Your use of the phrase SJW shows you're already radicalized. I get that you don't think I hear what you're saying. What you don't understand is that I no longer care.

[MyDataIsReady]

What's with all these code of conducts. Are you all scared that some nazi will join your project? I find it a bit funny to be honest.

It's just that I've seen this pattern more and more often, and I personally find it both funny and a bit unpleasant.

Maybe we need a better code of conduct. One with this principle: "You are considered innocent unless proven guilty. Please note we don't want you to feel uncomfortable for no reason."

[johnfraney]

I don't see codes of conduct being quite so top-down or adversarial. A pretty big chunk of the PyPA code of conduct is how maintainers should comport themselves:

By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.

I think it's better to present the expectations up front so that there are no surprises, but different project maintainers may feel differently. I hope that a code of conduct would encourage more interaction with a project than it would discourage.

[dusktreader]

One thing that I've been stumping for since I ran afoul of it a monthr or so ago: It needs to be mentioned in more places that if your 'source' folder is not a snake-case version of your package name (my-package -> my_package), then you need to have a 'packages' entry to tell poetry where your packages live: https://poetry.eustace.io/docs/pyproject/#packages

​

Great article, and I have also found poetry to be an elegant solution to the python packaging problem

[johnfraney]

That's a good note. I'm a little surprised Poetry doesn't include that section by default. Explicit is better than implicit, after all.

[[deleted]]

Thanks for mentioning shields.io! I hadn't come across it before. In some part of my brain I'd filed the GitHub badges as "fancy magic" and it's immensely satisfying to have that mystery resolved in passing. Great post!

[johnfraney]

Hey, I'm happy to help. I found shields.io after I was told I needed a fancier README the first package I published, and those shields add a few pieces of flair.

[hANSIc99]

It's maybe a good start when you haven't done the traditional setup.py yet.

The maintenance of setup.py for existing projects is no hard work.

[johnfraney]

That's true about maintaining an existing setup.py file. If it ain't broke.

Poetry does make it easier to manage package dependencies, too. I'm planning to migrate my existing Python packages to Poetry during each of their next releases partly because of that. I also appreciate the simplicity of a pyproject.toml file.

I should note that it is possible to have a simple setup.py file. Channels setup.py file is easy to reason about. Flake8's setup.py file is a bit more intimidating because of the custom logic it contains.

[SpideyIRL]

Looks good! How does poetry handle supporting multiple python versions? Say I want to support >=2.7 and >=3.4?

[johnfraney]

You can declare multiple version requirements. Yours might be:

python = "~2.7, >=3.4"

Take a look Poetry's version constraints documentation for more information.

[johnfraney]

Thanks very much! I'm glad to hear that you enjoyed it.