mirror of
https://github.com/balkian/balkian.github.com.git
synced 2024-11-05 03:21:42 +00:00
291 lines
17 KiB
HTML
291 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>balkian.com - Publishing on PyPi
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
|
|
<!-- syntax highlighting CSS -->
|
|
<link rel="stylesheet" href="/theme/css/solarized.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">
|
|
<div id="navbar" class="navbar navbar-inverse navbar-static-bottom">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<ul class="nav navbar-nav">
|
|
<li >
|
|
<a href="/"><i class="fa fa-home fa-large"></i></a>
|
|
</li>
|
|
<li >
|
|
<a href="/category/cheats.html">Cheats</a>
|
|
</li>
|
|
<li class="active"
|
|
>
|
|
<a href="/category/misc.html">Misc</a>
|
|
</li>
|
|
<li >
|
|
<a href="/tags.html">Tags</a>
|
|
</li>
|
|
<li >
|
|
<a href="/pages/projects.html">Projects</a>
|
|
</li>
|
|
<li>
|
|
<a href="//jfernando.es" target="_blank">CV</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</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-bat.png">
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="about" style="clear:both;">
|
|
<!-- <h1 class="title">Interests</h1> -->
|
|
<div class="icons">
|
|
<span class="coolicon"><span class="fa fa-stack"> <i class="fa fa-square-o fa-stack-2x" ></i><i class="fa fa-stack-1x fa-linux"></i></span><span class="explanation">Linux lover</span></span>
|
|
<span class="coolicon"><span class="fa fa-stack"> <i class="fa fa-square-o fa fa-stack-2x" ></i><i class="fa fa-android"></i></span><span class="explanation">Android dev</span></span>
|
|
<span class="coolicon"><span class="fa fa-stack"> <i class="fa fa-square-o fa fa-stack-2x" ></i><i class="fa fa-github-alt"></i> </span><span class="explanation">GitHub user</span></span>
|
|
<span class="coolicon"><span class="fa fa-stack"> <i class="fa fa-square-o fa fa-stack-2x" ></i><i class="fa fa-stack-exchange"></i> </span><span class="explanation">StackExchange fan</span></span>
|
|
<span class="coolicon"><span class="fa fa-stack"> <i class="fa fa-square-o fa fa-stack-2x" ></i><i class="fa fa-music"></i> </span><span class="explanation">Music lover</span></span>
|
|
<span class="coolicon"><span class="fa fa-stack"> <i class="fa fa-square-o fa fa-stack-2x" ></i><i class="fa fa-film"></i> </span><span class="explanation">Movie fan</span></span>
|
|
<span class="coolicon"><span class="fa fa-stack"> <i class="fa fa-square-o fa fa-stack-2x" ></i><i class="fa fa-comments"></i> </span><span class="explanation">Always on IM</span></span>
|
|
<span class="coolicon"><span class="fa fa-stack"> <i class="fa fa-square-o fa fa-stack-2x" ></i><i class="fa fa-laptop"></i> </span><span class="explanation">Always on a PC</span></span>
|
|
<span class="coolicon"><span class="fa fa-stack"> <i class="fa fa-square-o fa fa-stack-2x" ></i><i class="fa fa-pencil"></i> </span><span class="explanation">Occassional writter</span></span>
|
|
<span class="coolicon"><span class="fa fa-stack"> <i class="fa fa-square-o fa fa-stack-2x" ></i><i class="fa fa-moon-o"></i> </span><span class="explanation">Night owl</span></span>
|
|
<span class="coolicon"><span class="fa fa-stack"> <i class="fa fa-square-o fa fa-stack-2x" ></i><i class="fa fa-terminal"></i></span> <span class="explanation">CLI user</span></span>
|
|
<span class="coolicon"><span class="fa fa-stack"> <i class="fa fa-square-o fa fa-stack-2x" ></i><i class="fa fa-flag"></i></span> <span class="explanation">Linguist wannabe</span></span>
|
|
<span class="coolicon"><span class="fa fa-stack"> <i class="fa fa-square-o fa fa-stack-2x" ></i><i class="fa fa-code"></i> </span> <span class="explanation">Love to code</span></span>
|
|
<span class="coolicon"><span class="fa fa-stack"> <i class="fa fa-square-o fa fa-stack-2x" ></i><i class="fa fa-book"></i></span> <span class="explanation">Keen reader</span></span>
|
|
<span class="coolicon"><span class="fa fa-stack"> <i class="fa fa-square-o fa fa-stack-2x" ></i><i class="fa fa-quote-right"></i></span> <span class="explanation">Quotes on demand</span></span>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entries">
|
|
<h2 class="title">Latest entries</h2>
|
|
<dl>
|
|
<dt><a href="/hdmi-vga-adapter-issues-with-raspberry-pi.html">HDMI-VGA adapter issues with Raspberry Pi</a></dt>
|
|
<dd class="tag"><a class="label" href="/tag/rpi.html">rpi</a></dd>
|
|
<dt><a href="/progress-bars-in-python.html">Progress bars in python</a></dt>
|
|
<dd class="tag"><a class="label" href="/tag/python.html">python</a></dd>
|
|
<dt><a href="/arch-linux-fixes.html">Arch Linux Fixes</a></dt>
|
|
<dd class="tag"><a class="label" href="/tag/arch.html">arch</a></dd>
|
|
<dd class="tag"><a class="label" href="/tag/linux.html">linux</a></dd>
|
|
<dt><a href="/org-mode-tricks.html">Org-mode tricks</a></dt>
|
|
<dd class="tag"><a class="label" href="/tag/emacs.html">emacs</a></dd>
|
|
<dd class="tag"><a class="label" href="/tag/productivity.html">productivity</a></dd>
|
|
<dd class="tag"><a class="label" href="/tag/editor.html">editor</a></dd>
|
|
<dd class="tag"><a class="label" href="/tag/org.html">org</a></dd>
|
|
<dt><a href="/sharing-dotfiles.html">Sharing dotfiles</a></dt>
|
|
<dd class="tag"><a class="label" href="/tag/github.html">github</a></dd>
|
|
<dd class="tag"><a class="label" href="/tag/git.html">git</a></dd>
|
|
<dd class="tag"><a class="label" href="/tag/dotfiles.html">dotfiles</a></dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<!--Sidebar content-->
|
|
</div>
|
|
<div id="content">
|
|
<!--Body content-->
|
|
<div class="postnav">
|
|
<span class="previouspost"><i class="fa fa-chevron-left"></i> <a href="updating-eurolovemap.html">Updating EuroLoveMap</a></span>
|
|
<span class='nextpost'><a href="/proxies-with-apache-and-python.html">Proxies with Apache and python</a> <i class="fa fa-chevron-right"></i></span>
|
|
</div>
|
|
<div class="posthead">
|
|
<h2 class="title">Publishing on PyPi</h2>
|
|
<span class="meta date">2014-09-27</span>
|
|
<span class="tag"><a href="/tag/github.html" class="label label-default">github</a></span>
|
|
<span class="tag"><a href="/tag/python.html" class="label label-default">python</a></span>
|
|
<span class="tag"><a href="/tag/pypi.html" class="label label-default">pypi</a></span>
|
|
</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>
|
|
<table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1
|
|
2
|
|
3
|
|
4
|
|
5
|
|
6
|
|
7
|
|
8
|
|
9
|
|
10
|
|
11
|
|
12
|
|
13</pre></div></td><td class="code"><div class="highlight"><pre><span></span><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"></span>
|
|
<span class="s"> pypi # the live PyPI</span>
|
|
<span class="s"> 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></div>
|
|
</td></tr></table><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>
|
|
<p>This should be the structure:</p>
|
|
<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>
|
|
<table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
|
|
2</pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="k">[metadata]</span>
|
|
<span class="na">description-file</span> <span class="o">=</span> <span class="s">README.md</span>
|
|
</pre></div>
|
|
</td></tr></table><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>
|
|
<table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1
|
|
2
|
|
3
|
|
4
|
|
5
|
|
6
|
|
7
|
|
8
|
|
9
|
|
10
|
|
11
|
|
12</pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">distutils.core</span> <span class="kn">import</span> <span class="n">setup</span>
|
|
|
|
<span class="n">setup</span><span class="p">(</span><span class="n">name</span> <span class="o">=</span> <span class="s1">'mypackage'</span><span class="p">,</span>
|
|
<span class="n">packages</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'mypackage'</span><span class="p">],</span> <span class="c1"># this must be the same as the name above</span>
|
|
<span class="n">version</span> <span class="o">=</span> <span class="s1">'{ version }'</span><span class="p">,</span>
|
|
<span class="n">description</span> <span class="o">=</span> <span class="s1">'{ description }'</span><span class="p">,</span>
|
|
<span class="n">author</span> <span class="o">=</span> <span class="s1">'{ name }'</span><span class="p">,</span>
|
|
<span class="n">email</span> <span class="o">=</span> <span class="s1">'{ email }'</span><span class="p">,</span>
|
|
<span class="n">url</span> <span class="o">=</span> <span class="s1">'https://github.com/{user}/{package}'</span><span class="p">,</span> <span class="c1"># URL to the github repo</span>
|
|
<span class="n">download</span>\<span class="n">_url</span> <span class="o">=</span> <span class="s1">'https://github.com/{user}/{repo}/tarball/{version}'</span><span class="p">,</span>
|
|
<span class="n">keywords</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'websockets'</span><span class="p">,</span> <span class="s1">'display'</span><span class="p">,</span> <span class="s1">'d3'</span><span class="p">],</span> <span class="c1"># list of keywords that represent your package</span>
|
|
<span class="n">classifiers</span> <span class="o">=</span> <span class="p">[],</span> <span class="p">)</span>
|
|
</pre></div>
|
|
</td></tr></table><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>
|
|
<table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
|
|
2</pre></div></td><td class="code"><div class="highlight"><pre><span></span>git tag <span class="o">{</span>version<span class="o">}</span> -m <span class="s2">"{ Description of this tag/version}"</span>
|
|
git push --tags origin master
|
|
</pre></div>
|
|
</td></tr></table></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="fa fa-github"></i></a></li>
|
|
<li><a href="http://bitbucket.com/balkian"><i class="fa fa-bitbucket"></i></a></li>
|
|
<li><a href="http://twitter.com/balkian"><i class="fa fa-twitter"></i></a></li>
|
|
<li><a href="https://plus.google.com/u/0/111897020957944410316"><i class="fa fa-google-plus"></i></a></li>
|
|
<li><a href="http://linkedin.com/in/jfsanchezrada"><i class="fa fa-linkedin"></i></a></li>
|
|
<li><a href="http://facebook.com/balkian"><i class="fa fa-facebook"></i></a></li>
|
|
</ul>
|
|
<p>
|
|
<i class="fa fa-creative-commons"></i> Creative Commons A-SA-NC
|
|
</p>
|
|
</footer>
|
|
</div>
|
|
|
|
<script src="/theme/js/jquery-2.0.2.min.js"></script>
|
|
<!-- Piwik -->
|
|
<script type="text/javascript">
|
|
var _paq = _paq || [];
|
|
_paq.push(['trackPageView']);
|
|
_paq.push(['enableLinkTracking']);
|
|
(function() {
|
|
var u="//piwik.sinpapel.es/";
|
|
_paq.push(['setTrackerUrl', u+'piwik.php']);
|
|
_paq.push(['setSiteId', 2]);
|
|
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
|
|
g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s);
|
|
})();
|
|
</script>
|
|
<noscript><p><img src="//piwik.sinpapel.es/piwik.php?idsite=2" style="border:0;" alt="" /></p></noscript>
|
|
<!-- End Piwik Code -->
|
|
|
|
<!--<script src="/js/bootstrap.min.js"></script>-->
|
|
</body>
|
|
</html> |