2015-01-22 22:05:35 +00:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
|
|
|
<title></title>
|
|
|
|
|
<meta name="viewport" content="width=device-width">
|
|
|
|
|
|
|
|
|
|
<!-- syntax highlighting CSS -->
|
|
|
|
|
<link rel="stylesheet" href="/theme/css/solarized-dark.css">
|
|
|
|
|
<!--<link href="/css/bootstrap.css" rel="stylesheet">-->
|
|
|
|
|
<link rel="stylesheet" href="/theme/font-awesome/css/font-awesome.min.css">
|
|
|
|
|
|
|
|
|
|
<!--<link rel="stylesheet" href="/css/bootstrap-responsive.min.css">-->
|
|
|
|
|
|
|
|
|
|
<!-- Custom CSS -->
|
|
|
|
|
<link rel="stylesheet" media="only screen" href="/theme/css/main.css">
|
|
|
|
|
<link rel="stylesheet" media="only screen and (min-width: 0px) and (max-width: 599px)" href="/theme/css/main-xs.css">
|
|
|
|
|
<link rel="stylesheet" media="only screen and (min-width: 600px) and (max-width: 1199px)" href="/theme/css/main-medium.css">
|
|
|
|
|
<link rel="stylesheet" media="only screen and (min-width: 1200px)" href="/theme/css/main-desktop.css">
|
|
|
|
|
<link href='http://fonts.googleapis.com/css?family=Open+Sans:300|Comfortaa' rel='stylesheet' type='text/css'>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<div id="container" class="container">
|
|
|
|
|
<header id="header">
|
|
|
|
|
<h1 id="headline"><a href="/">balkian</a><a class="inv" href="/">.com</a></h1>
|
|
|
|
|
<div id="navbar" class="navbar navbar-inverse navbar-static-bottom">
|
|
|
|
|
<div class="container">
|
|
|
|
|
<div class="navbar-header">
|
|
|
|
|
<ul class="nav navbar-nav">
|
|
|
|
|
<li class="active" >
|
|
|
|
|
<a href="/"><i class="icon-home icon-large"></i> Blog</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/pages/about.html">About</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/pages/cv.html">CV</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/pages/projects.html">Projects</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/pages/to-do.html">To-Do</a>
|
|
|
|
|
</li>
|
|
|
|
|
<!--<li class="dropdown">-->
|
|
|
|
|
<!--<a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>-->
|
|
|
|
|
<!--<ul class="dropdown-menu">-->
|
|
|
|
|
<!--<li><a href="#">Action</a></li>-->
|
|
|
|
|
<!--<li><a href="#">Another action</a></li>-->
|
|
|
|
|
<!--<li><a href="#">Something else here</a></li>-->
|
|
|
|
|
<!--<li class="divider"></li>-->
|
|
|
|
|
<!--<li class="dropdown-header">Nav header</li>-->
|
|
|
|
|
<!--<li><a href="#">Separated link</a></li>-->
|
|
|
|
|
<!--<li><a href="#">One more separated link</a></li>-->
|
|
|
|
|
<!--</ul>-->
|
|
|
|
|
<!--</li>-->
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</header>
|
|
|
|
|
<div id="contentwrapper">
|
|
|
|
|
<div id="sidebar" >
|
|
|
|
|
<div id="badge" class="flip-container" ontouchstart="this.classList.toggle('hover');">
|
|
|
|
|
<div class="flipper sticky">
|
|
|
|
|
<div class="front">
|
|
|
|
|
<!-- front content -->
|
|
|
|
|
<img id="avatar" width=100% src="/theme/img/me.png">
|
|
|
|
|
</div>
|
|
|
|
|
<div class="back">
|
|
|
|
|
<!-- back content -->
|
|
|
|
|
<img id="picture" width=100% src="/theme/img/me.jpg">
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="entries">
|
|
|
|
|
<h1 class="title">Latest entries</h1>
|
|
|
|
|
<dl>
|
2015-01-22 22:28:51 +00:00
|
|
|
<dt><a href="/zotero.html">Zotero</a></dt>
|
2015-01-22 22:05:35 +00:00
|
|
|
<a class="tag" href="/tag/zotero.html"><dd class="label label-default">zotero</dd></a>
|
|
|
|
|
<a class="tag" href="/tag/webdav.html"><dd class="label label-default">webdav</dd></a>
|
|
|
|
|
<a class="tag" href="/tag/nginx.html"><dd class="label label-default">nginx</dd></a>
|
|
|
|
|
<a class="tag" href="/tag/apache.html"><dd class="label label-default">apache</dd></a>
|
2015-01-22 22:28:51 +00:00
|
|
|
<dt><a href="/proxies-with-apache-and-python.html">Proxies with Apache and python</a></dt>
|
2015-01-22 22:05:35 +00:00
|
|
|
<a class="tag" href="/tag/python.html"><dd class="label label-default">python</dd></a>
|
|
|
|
|
<a class="tag" href="/tag/apache.html"><dd class="label label-default">apache</dd></a>
|
|
|
|
|
<a class="tag" href="/tag/proxy.html"><dd class="label label-default">proxy</dd></a>
|
|
|
|
|
<a class="tag" href="/tag/gunicorn.html"><dd class="label label-default">gunicorn</dd></a>
|
|
|
|
|
<a class="tag" href="/tag/uwsgi.html"><dd class="label label-default">uwsgi</dd></a>
|
|
|
|
|
</dl>
|
|
|
|
|
</div>
|
|
|
|
|
<!--Sidebar content-->
|
|
|
|
|
</div>
|
|
|
|
|
<div id="content">
|
|
|
|
|
<!--Body content-->
|
|
|
|
|
<div class="postnav">
|
|
|
|
|
<a href="updating-eurolovemap.html"><span class="previouspost"><i class="icon-chevron-sign-left"></i> Updating EuroLoveMap</a></span>
|
|
|
|
|
<span class='nextpost'><a href="/proxies-with-apache-and-python.html">Proxies with Apache and python <i class="icon-chevron-sign-right"></i></span></a>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="posthead">
|
|
|
|
|
<h2 class="title">Publishing in PyPi</h2>
|
|
|
|
|
<span class="meta date">2014-09-27</span>
|
|
|
|
|
<a class="tag" href="/tag/github.html"><span class="label label-default">github</span></a>
|
|
|
|
|
<a class="tag" href="/tag/python.html"><span class="label label-default">python</span></a>
|
|
|
|
|
<a class="tag" href="/tag/pypi.html"><span class="label label-default">pypi</span></a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="post">
|
|
|
|
|
<p>Developing a python module and publishing it on Github is cool, but most
|
|
|
|
|
of the times you want others to download and use it easily. That is the
|
|
|
|
|
role of PyPi, the python package repository. In this post I show you how
|
|
|
|
|
to publish your package in less than 10 minutes.</p>
|
|
|
|
|
<div class="section" id="choose-a-fancy-name">
|
|
|
|
|
<h2>Choose a fancy name</h2>
|
|
|
|
|
<p>If you haven't done so yet, take a minute or two to think about this. To
|
|
|
|
|
publish on PyPi you need a name for your package that isn't taken.
|
|
|
|
|
What's more, a catchy and unique name will help people remember your
|
|
|
|
|
module and feel more inclined to at least try it.</p>
|
|
|
|
|
<p>The package name should hint what your module does, but that's not
|
|
|
|
|
always the case. That's your call. I personally put uniqueness and
|
|
|
|
|
memorability over describing the functionality.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="section" id="create-a-pypirc-configuration-file">
|
|
|
|
|
<h2>Create a .pypirc configuration file</h2>
|
|
|
|
|
<pre class="code cfg literal-block">
|
|
|
|
|
<span class="err">[distutils]</span> <span class="c1"># this tells distutils what package indexes you can push to</span>
|
|
|
|
|
<span class="na">index-servers</span> <span class="o">=</span><span class="s">
|
|
|
|
|
pypi # the live PyPI
|
|
|
|
|
pypitest # test PyPI</span>
|
|
|
|
|
|
|
|
|
|
<span class="err">[pypi]</span> <span class="c1"># authentication details for live PyPI</span>
|
|
|
|
|
<span class="na">repository</span> <span class="o">=</span> <span class="s">https://pypi.python.org/pypi</span>
|
|
|
|
|
<span class="na">username</span> <span class="o">=</span> <span class="s">{ your_username }</span>
|
|
|
|
|
<span class="na">password</span> <span class="o">=</span> <span class="s">{ your_password } # not necessary</span>
|
|
|
|
|
|
|
|
|
|
<span class="err">[pypitest]</span> <span class="c1"># authentication details for test PyPI</span>
|
|
|
|
|
<span class="na">repository</span> <span class="o">=</span> <span class="s">https://testpypi.python.org/pypi</span>
|
|
|
|
|
<span class="na">username</span> <span class="o">=</span> <span class="s">{ your_username }</span>
|
|
|
|
|
</pre>
|
|
|
|
|
<p>As you can see, you need to register both in the <a class="reference external" href="https://pypi.python.org/pypi?%3Aaction=register_form">main pypi
|
|
|
|
|
repository</a> and
|
|
|
|
|
the <a class="reference external" href="https://testpypi.python.org/pypi?%3Aaction=register_form">testing
|
|
|
|
|
server</a>.
|
|
|
|
|
The usernames and passwords might be different, that is up to you!</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="section" id="prepare-your-package">
|
|
|
|
|
<h2>Prepare your package</h2>
|
|
|
|
|
<pre class="literal-block">
|
|
|
|
|
root-dir/ # Any name you want
|
|
|
|
|
setup.py
|
|
|
|
|
setup.cfg
|
|
|
|
|
LICENSE.txt
|
|
|
|
|
README.md
|
|
|
|
|
mypackage/
|
|
|
|
|
__init__.py
|
|
|
|
|
foo.py
|
|
|
|
|
bar.py
|
|
|
|
|
baz.py
|
|
|
|
|
</pre>
|
|
|
|
|
<div class="section" id="setup-cfg">
|
|
|
|
|
<h3>setup.cfg</h3>
|
|
|
|
|
<pre class="code cfg literal-block">
|
|
|
|
|
<span class="k">[metadata]</span>
|
|
|
|
|
<span class="na">description-file</span> <span class="o">=</span> <span class="s">README.md</span>
|
|
|
|
|
</pre>
|
|
|
|
|
<p>The markdown README is the <em>de facto</em> standard in Github, but you can
|
|
|
|
|
also use rST (reStructuredText), the standard in the python community.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="section" id="setup-py">
|
|
|
|
|
<h3>setup.py</h3>
|
|
|
|
|
<p>{% highlight python %} from distutils.core import setup setup( name =
|
|
|
|
|
'mypackage', packages = ['mypackage'], # this must be the same as the
|
|
|
|
|
name above version = '{ version }', description = '{ description }',
|
|
|
|
|
author = '{ name }', author_email = '{ email }', url =
|
|
|
|
|
'<a class="reference external" href="https://github.com">https://github.com</a>/{user}/{package}', # URL to the github repo
|
|
|
|
|
download_url = '<a class="reference external" href="https://github.com">https://github.com</a>/{user}/{repo}/tarball/{version}',
|
|
|
|
|
keywords = ['websockets', 'display', 'd3'], # list of keywords that
|
|
|
|
|
represent your package classifiers = [], ) {% endhighlight %}</p>
|
|
|
|
|
<p>You might notice that the download_url points to a Github URL. We could
|
|
|
|
|
host our package anywhere, but Github is a convenient option. To create
|
|
|
|
|
the tarball and the zip packages, you only need to tag a tag in your
|
|
|
|
|
repository and push it to github:</p>
|
|
|
|
|
<pre class="literal-block">
|
|
|
|
|
git tag {version} -m "{ Description of this tag/version}"
|
|
|
|
|
git push --tags origin master
|
|
|
|
|
</pre>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="section" id="push-to-the-testing-main-pypi-server">
|
|
|
|
|
<h2>Push to the testing/main pypi server</h2>
|
|
|
|
|
<p>It is advisable that you try your package on the test repository and fix
|
|
|
|
|
any problems first. The process is simple:
|
|
|
|
|
<tt class="docutils literal">python setup.py register <span class="pre">-r</span> {pypitest/pypi} python setup.py sdist upload <span class="pre">-r</span> {pypitest/pypi}</tt></p>
|
|
|
|
|
<p>If everything went as expected, you can now install your package through
|
|
|
|
|
pip and browse your package's page. For instance, check my senpy
|
|
|
|
|
package: <a class="reference external" href="https://pypi.python.org/pypi/senpy">https://pypi.python.org/pypi/senpy</a> <tt class="docutils literal">pip install senpy</tt></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="clear"></div>
|
|
|
|
|
</div>
|
|
|
|
|
<footer role="contentinfo">
|
|
|
|
|
<div class="contact">
|
|
|
|
|
<p>
|
|
|
|
|
J. Fernando Sánchez Rada | balkian
|
|
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
<ul id="social">
|
|
|
|
|
<li><a href="http://github.com/balkian"><i class="icon-github"></i></a></li>
|
|
|
|
|
<li><a href="http://bitbucket.com/balkian"><i class="icon-bitbucket"></i></a></li>
|
|
|
|
|
<li><a href="http://twitter.com/balkian"><i class="icon-twitter"></i></a></li>
|
|
|
|
|
<li><a href="https://plus.google.com/u/0/111897020957944410316"><i class="icon-google-plus"></i></a></li>
|
|
|
|
|
<li><a href="http://linkedin.com/in/jfsanchezrada"><i class="icon-linkedin"></i></a></li>
|
|
|
|
|
<li><a href="http://facebook.com/balkian"><i class="icon-facebook-sign"></i></a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<p>
|
|
|
|
|
Creative Commons A-SA-NC
|
|
|
|
|
</p>
|
|
|
|
|
</footer>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script src="/theme/js/jquery-2.0.2.min.js"></script>
|
|
|
|
|
<!--<script src="/js/bootstrap.min.js"></script>-->
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
