How do I package a python application to make it pip-installable?

by

Yes, MANIFEST.in and setup.py should be sufficient.

This blog post really has some good information on this topic:
Packaging a Django reusable app

And here’s another good, detailed overview that helped me a lot:
Python Packaging User Guide

Especially the tips to get your static files (templates) included are important as this might not be obvious at first.

And yes, you can specify required packages in your setup.py which are automatically fetched when installing your app.

For example:

    install_requires = [
        'django-profiles',
        'django-uni-forms',
    ],

Obviously now we have two places where dependencies are defined, but that doesn’t necessarily mean that these information are duplicated: setup.py vs requirements.txt

With this setup your package should be installable via pip.

As Pierre noted in the comments, there’s now also a relevant section in Django’s official documentation: Packaging your app

And then there is this “completely incomplete” guide, which really gives a great overview over packaging and uploading a package to PyPI: Sharing Your Labor of Love: PyPI Quick And Dirty

More Related Contents:

  1. ‘pip’ is not recognized as an internal or external command
  2. No module named pkg_resources
  3. Error on “pip install -U channels” command using for otree (Running setup.py bdist_wheel for twisted … error)
  4. django installation: cannot use pip to install django on linux(ubuntu)
  5. Can’t install psycopg2 with pip in virtualenv on Mac OS X 10.7
  6. How to install virtualenv without using sudo?
  7. WARNING: Running pip as the ‘root’ user
  8. Bypass confirmation prompt for pip uninstall
  9. Where does pip install its packages?
  10. can’t pip install mysql-python
  11. How to fix error “ERROR: Command errored out with exit status 1: python.” when trying to install django-heroku using pip [duplicate]
  12. How to override and extend basic Django admin templates?
  13. Using pip behind a proxy with CNTLM
  14. How can I build multiple submit buttons django form?
  15. How to install psycopg2 with “pip” on Python?
  16. Default filter in Django admin
  17. How to receive json data using HTTP POST request in Django 1.6?
  18. How do you reload a Django model module using the interactive interpreter via “manage.py shell”?
  19. Django – How to rename a model field using South?
  20. Django required field in model form
  21. How to get the domain name of my site within a Django template?
  22. How do I use the built in password reset/change views with my own templates
  23. Django Standalone Script
  24. “SSL certificate verify failed” using pip to install packages
  25. one-to-many inline select with django admin
  26. django order_by query set, ascending and descending
  27. Django filter JSONField list of dicts
  28. How to add custom field in ModelSerializer?
  29. “{% extends %}” vs “{% include %}” in Django Templates
  30. XlsxWriter object save as http response to create download in Django

Leave a Comment