PyPI Overview & Sample Project Setup

00:00 Welcome to the Real Python guide on how to publish an open-source Python package to PyPI. In this set of videos, you’re going to learn how to prepare a Python package for publication and upload your packages to PyPI. PyPI is a huge collection of open-source projects for Python, ranging from everything like helloworld to game engines and deep learning libraries. This is a great way to distribute your work, as someone just needs to use pip to install it! In this set of videos, you’ll be working with an example project that can be used to read Real Python articles. If you have your own project you’d like to upload, feel free to use that instead.

00:35 But let’s take a look at what you’ll be building.

00:39 If you go to github.com/realpython/reader, you’ll see the Real Python reader. You can download this to your computer by going to Clone or download and downloading a ZIP file.

00:51 Once you have that extracted, open the folder in your text editor of choice, and let’s take a look at the layout. Here you can see that everything’s contained inside this reader-master/ folder,

01:03 where there’s a reader/ folder with a number of Python source files, and then a tests/ folder with a couple of tests, and then some configuration files.

01:12 If you’d like to install this to your Python environment, you can go ahead to your terminal

01:20 and you can just say pip install realpython-reader.

01:27 Once you’ve got that, you can say python -m reader, and what you’ll end up with is a list of some of the most recent articles published on Real Python. If you’d like to open one of these up, just call it again—and you see that there’s these numbers here—you can just put a number and you’ll get the entire article printed out to your terminal here. So, that’s pretty cool! In the next video, you’re going to learn how to set up a simplified version of this so that you can upload it yourself.

02:00 We’re not going to go into too much detail on how this works, but just use this as an example project so that you can learn how to actually upload something to PyPI. I’ll see you there.