pipinator 0.1.2

Example Project to show how to package a Django project for pip

Pipinator
=========

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



Installing the project from a local directory:
----------------------------------------------


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

```
pip3 install -e ~/tmp/django-pip-project/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 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:
-----------------------------

```
python setup.py sdist
```

This creates a `dist/` directory containing a archive with your project.

**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:

```
pip install twine
twine upload dist/*

```