Leanpub Header

Skip to main content

pip install yours

A Practical Guide to Packaging and Publishing Python Projects on PyPI

Your code deserves to be on PyPI. pip install yours is a step-by-step guide to packaging and publishing Python projects — from project structure to your first live release on PyPI.

Minimum price

$14.99

$19.00

You pay

$19.00

Author earns

$15.20
$

...Or Buy With Credits!

You can get credits with a paid monthly or annual Reader Membership, or you can buy them here.
PDF
EPUB
WEB
32
Pages
About

About

About the Book

Every Python developer has written code worth sharing — a utility, a library, a tool that solves a real problem. But getting that code from your local machine onto PyPI, where anyone in the world can install it with a single pip install command, can feel like a maze of configuration files, build tools, and version management.


pip install yours cuts through the noise. This book walks you through the entire packaging journey: structuring your project, writing your pyproject.toml, building distributions, and publishing to PyPI with confidence. You'll also learn how to version your releases, manage dependencies properly, and keep your package maintainable over time.


Whether you're publishing your first open-source library or professionalizing an internal tool, this is the practical, no-fluff guide you need to make your code installable by the world.

Author

About the Author

Nuno Bispo

Nuno Bispo is a Senior Software Engineer with more than 15 years of experience in software development.

He has worked in various industries such as insurance, banking, and airlines, where he focused on building software using low-code platforms.

For the past years, Nuno has been improving his skills in Python and Django and has worked as a freelance consultant on many international projects and written several innovative articles on his blog.

Currently, Nuno works as an Integration Architect for a major multinational corporation.

He has a degree in Computer Engineering.

Contents

Table of Contents

Chapter 0: Welcome

  1. Purpose
  2. What you need
  3. PyPI, Test PyPI, and what you’ll build
  4. About the author

Chapter 1: Introduction

  1. PyPI and pyproject.toml in a nutshell

Chapter 2: Your First Package

  1. Step 1: Create the project layout
  2. Step 2: Add pyproject.toml
  3. Step 3: Build the package
  4. Step 4: Install locally (editable)
  5. Step 5: Upload to Test PyPI
  6. Step 6: Install from Test PyPI

Chapter 3: Structure, Metadata, and Building

  1. Project layout: the src/ layout
  2. Metadata in pyproject.toml
  3. Version: one place, semantic versioning
  4. Dependencies and optional extras
  5. Build backend and what build produces

Chapter 4: Tests, README, and Publishing to PyPI

  1. Running tests
  2. README as the PyPI long description
  3. PyPI account and API token
  4. Upload with twine
  5. Test on Test PyPI first, then production
  6. Release flow: version, tag, build, upload
  7. One simple GitHub Action

Chapter 5: Next Steps and Reference

  1. Next steps
  2. Minimal pyproject.toml template
  3. Key commands
  4. Pre-publish checklist

Get the free sample chapters

Click the buttons to get the free sample in PDF or EPUB, or read the sample online here

The Leanpub 60 Day 100% Happiness Guarantee

Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.

Now, this is technically risky for us, since you'll have the book or course files either way. But we're so confident in our products and services, and in our authors and readers, that we're happy to offer a full money back guarantee for everything we sell.

You can only find out how good something is by trying it, and because of our 100% money back guarantee there's literally no risk to do so!

So, there's no reason not to click the Add to Cart button, is there?

See full terms...

Earn $8 on a $10 Purchase, and $16 on a $20 Purchase

We pay 80% royalties on purchases of $7.99 or more, and 80% royalties minus a 50 cent flat fee on purchases between $0.99 and $7.98. You earn $8 on a $10 sale, and $16 on a $20 sale. So, if we sell 5000 non-refunded copies of your book for $20, you'll earn $80,000.

(Yes, some authors have already earned much more than that on Leanpub.)

In fact, authors have earned over $14 million writing, publishing and selling on Leanpub.

Learn more about writing on Leanpub

Free Updates. DRM Free.

If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).

Most Leanpub books are available in PDF (for computers) and EPUB (for phones, tablets and Kindle). The formats that a book includes are shown at the top right corner of this page.

Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.

Learn more about Leanpub's ebook formats and where to read them

Write and Publish on Leanpub

You can use Leanpub to easily write, publish and sell in-progress and completed ebooks and online courses!

Leanpub is a powerful platform for serious authors, combining a simple, elegant writing and publishing workflow with a store focused on selling in-progress ebooks.

Leanpub is a magical typewriter for authors: just write in plain text, and to publish your ebook, just click a button. (Or, if you are producing your ebook your own way, you can even upload your own PDF and/or EPUB files and then publish with one click!) It really is that easy.

Learn more about writing on Leanpub