Skip to main content

Pipinator

This is just a sample project to illustrate how to package a Django project so it can be installed over PyPi with pip.

You can find the source code at: https://github.com/antonpirker/django-pip-project The important parts are in the files: django-pip-project/setup.py and django-pip-project/pipinator/__main__.py.

Installing the project from a local directory:

If you clone the code repository to a local directory (~/tmp/django-pip-project/) you can install the project with the following command:

$ pip3 install -e ~/tmp/django-pip-project/

After this you can run the debug server of the project with a simple:

$ pipinator

You need to run pipinator inside (or above) the local directory you cloned the project to or you will get an SuspiciousFileOperation Error.

Uploading to PyPI:

Check description format:

Check if the description and long_description can be rendered by PyPI:

$ pip install readme_renderer
$ python setup.py check -r -s

Create a source distribution:

This creates a dist/ directory containing a archive with your project:

$ python setup.py sdist

Note: There are also other ways to package your project. See the Python documentation for a complete guide on how to package your project: https://packaging.python.org/tutorials/distributing-packages/#packaging-your-project

Create an account on PyPI:

See: https://packaging.python.org/tutorials/distributing-packages/#create-an-account

Upload your project to PyPI:

You have to use twine to upload your package (you will need to enter your username and password):

$ pip install twine
$ twine upload dist/*

If you want to save your credentials to a file, so you do not have to enter them every time you upload a version see: https://packaging.python.org/tutorials/distributing-packages/#create-an-account

Metadata

Release files for pipinator 0.1.20

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pipinator 0.1.20
File Size Uploaded
pipinator-0.1.20.tar.gz 124.0 kB Details

Release files / pipinator-0.1.20.tar.gz

Download URL pipinator-0.1.20.tar.gz
Size 124.0 kB
Tags Source
SHA-256 checksum
How to use checksums
b4c44b32cc555fb3addafbe964aedb820f6b31a231dc9791c16f91e61d5fb738
BLAKE2b-256 checksum
How to use checksums
4861f66d4a47c685ef87b8888707a2886c0af4d71f23d4f7fe8ec3c1f0e7a816
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.20 This release

1 release file

0.1.18

1 release file

0.1.17

1 release file

0.1.16

1 release file

0.1.15

1 release file

0.1.14

1 release file

0.1.13

1 release file

0.1.12

1 release file

0.1.11

1 release file

0.1.10

1 release file

0.1.9

1 release file

0.1.8

1 release file

0.1.7

1 release file

0.1.6

1 release file

0.1.5

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page