mirror of
https://github.com/almet/notmyidea.git
synced 2025-04-28 19:42:37 +02:00
236 lines
No EOL
9.9 KiB
HTML
236 lines
No EOL
9.9 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Sprinting on distutils2 in Tours</title>
|
|
<meta charset="utf-8" />
|
|
<link rel="stylesheet" href="./theme/css/main.css" type="text/css" />
|
|
<link href="./feeds/all.atom.xml" type="application/atom+xml" rel="alternate" title="Alexis' log ATOM Feed" />
|
|
|
|
|
|
<!--[if IE]>
|
|
<script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
|
|
<!--[if lte IE 7]>
|
|
<link rel="stylesheet" type="text/css" media="all" href="./css/ie.css"/>
|
|
<script src="./js/IE8.js" type="text/javascript"></script><![endif]-->
|
|
|
|
<!--[if lt IE 7]>
|
|
<link rel="stylesheet" type="text/css" media="all" href="./css/ie6.css"/><![endif]-->
|
|
|
|
</head>
|
|
|
|
<body id="index" class="home">
|
|
|
|
<a href="http://github.com/ametaireau/">
|
|
|
|
<img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png" alt="Fork me on GitHub" />
|
|
|
|
</a>
|
|
|
|
<header id="banner" class="body">
|
|
<h1><a href=".">Alexis' log </a></h1>
|
|
<nav><ul>
|
|
|
|
|
|
|
|
<li><a href="./pages/projects.html">projects</a></li>
|
|
|
|
|
|
|
|
<li ><a href="./category/asso.html">asso</a></li>
|
|
|
|
<li class="active"><a href="./category/dev.html">dev</a></li>
|
|
|
|
<li ><a href="./category/python.html">python</a></li>
|
|
|
|
<li ><a href="./category/system.html">system</a></li>
|
|
|
|
<li ><a href="./category/thoughts.html">thoughts</a></li>
|
|
|
|
</ul></nav>
|
|
</header><!-- /#banner -->
|
|
|
|
<section id="content" class="body">
|
|
<article>
|
|
<header> <h1 class="entry-title"><a href=""
|
|
rel="bookmark" title="Permalink to Sprinting on distutils2 in Tours">Sprinting on distutils2 in Tours</a></h1> </header>
|
|
<div class="entry-content">
|
|
<footer class="post-info">
|
|
<abbr class="published" title="2010-07-06T00:00:00">
|
|
Tue 06 July 2010
|
|
</abbr>
|
|
|
|
|
|
<address class="vcard author">
|
|
By <a class="url fn" href="./author/Alexis Métaireau.html">Alexis Métaireau</a>
|
|
</address>
|
|
|
|
<p>In <a href="./category/dev.html">dev</a>. </p>
|
|
|
|
|
|
|
|
</footer><!-- /.post-info -->
|
|
<p>Yesterday, as I was traveling to Tours, I've took some time to
|
|
visit Éric, another student who's working on distutils2 this
|
|
summer, as a part of the GSoC. Basically, it was to take a drink,
|
|
discuss a bit about distutils2, our respective tasks and general
|
|
feelings, and to put a face on a pseudonym. I'd really enjoyed this
|
|
time, because Éric knows a lot of things about mercurial and python
|
|
good practices, and I'm eager to learn about those. So, we have
|
|
discussed about things, have not wrote so much code, but have some
|
|
things to propose so far, about documentation, and I also provides
|
|
here some bribes of conversations we had.</p>
|
|
<div class="section" id="documentation">
|
|
<h2>Documentation</h2>
|
|
<p>While writing the PyPI simple index crawler documentation, I
|
|
realized that we miss some structure, or how-to about the
|
|
documentation. Yep, you read well. We lack documentation on how to
|
|
make documentation. Heh. We're missing some rules to follow, and
|
|
this lead to a not-so-structured final documentation. We probably
|
|
target three type of publics, and we can split the documentation
|
|
regarding those:</p>
|
|
<ul class="simple">
|
|
<li><strong>Packagers</strong> who want to distribute their softwares.</li>
|
|
<li><strong>End users</strong> who need to understand how to use end user
|
|
commands, like the installer/uninstaller</li>
|
|
<li><strong>packaging coders</strong> who <em>use</em> distutils2, as a base for
|
|
building a package manager.</li>
|
|
</ul>
|
|
<p>We also need to discuss about a pattern to follow while writing
|
|
documentation. How many parts do we need ? Where to put the API
|
|
description ? etc. That's maybe seems to be not so important, but I
|
|
guess the readers would appreciate to have the same structure all
|
|
along distutils2 documentation.</p>
|
|
</div>
|
|
<div class="section" id="mercurial">
|
|
<h2>Mercurial</h2>
|
|
<p>I'm really <em>not</em> a mercurial power user. I use it on daily basis,
|
|
but I lack of basic knowledge about it. Big thanks Éric for sharing
|
|
yours with me, you're of a great help. We have talked about some
|
|
mercurial extensions that seems to make the life simpler, while
|
|
used the right way. I've not used them so far, so consider this as
|
|
a personal note.</p>
|
|
<ul class="simple">
|
|
<li>hg histedit, to edit the history</li>
|
|
<li>hg crecord, to select the changes to commit</li>
|
|
</ul>
|
|
<p>We have spent some time to review a merge I made sunday, to
|
|
re-merge it, and commit the changes as a new changeset. Awesome.
|
|
These things make me say I <strong>need</strong> to read
|
|
<a class="reference external" href="http://hgbook.red-bean.com/read/">the hg book</a>, and will do as
|
|
soon as I got some spare time: mercurial seems to be simply great.
|
|
So ... Great. I'm a powerful merger now !</p>
|
|
</div>
|
|
<div class="section" id="on-using-tools">
|
|
<h2>On using tools</h2>
|
|
<p>Because we <em>also</em> are <em>hackers</em>, we have shared a bit our ways to
|
|
code, the tools we use, etc. Both of us were using vim, and I've
|
|
discovered vimdiff and hgtk, which will completely change the way I
|
|
navigate into the mercurial history. We aren't "power users", so we
|
|
have learned from each other about vim tips. You can find
|
|
<a class="reference external" href="http://github.com/ametaireau/dotfiles">my dotfiles on github</a>,
|
|
if it could help. They're not perfect, and not intended to be,
|
|
because changing all the time, as I learn. Don't hesitate to have a
|
|
look, and to propose enhancements if you have !</p>
|
|
</div>
|
|
<div class="section" id="on-being-pythonic">
|
|
<h2>On being pythonic</h2>
|
|
<p>My background as an old Java user disserves me so far, as the
|
|
paradigms are not the same while coding in python. Hard to find the
|
|
more pythonic way to do, and sometimes hard to unlearn my way to
|
|
think about software engineering. Well, it seems that the only
|
|
solution is to read code, and to re-read import this from times to
|
|
times !
|
|
<a class="reference external" href="http://python.net/~goodger/projects/pycon/2007/idiomatic/handout.html">Coding like a pythonista</a>
|
|
seems to be a must-read, so, I know what to do.</p>
|
|
</div>
|
|
<div class="section" id="conclusion">
|
|
<h2>Conclusion</h2>
|
|
<p>It was really great. Next time, we'll need to focus a bit more on
|
|
distutils2, and to have a bullet list of things to do, but days
|
|
like this one are opportunities to catch ! We'll probably do
|
|
another sprint in a few weeks, stay tuned !</p>
|
|
</div>
|
|
|
|
</div><!-- /.entry-content -->
|
|
|
|
<div class="comments">
|
|
<h2>Comments !</h2>
|
|
<div id="disqus_thread"></div>
|
|
<script type="text/javascript">
|
|
var disqus_identifier = "sprinting-on-distutils2-in-tours.html";
|
|
(function() {
|
|
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
|
|
dsq.src = 'http://blog-notmyidea.disqus.com/embed.js';
|
|
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
|
|
})();
|
|
</script>
|
|
</div>
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
<section id="extras" class="body">
|
|
|
|
<div class="blogroll">
|
|
<h2>blogroll</h2>
|
|
<ul>
|
|
|
|
<li><a href="http://biologeek.org">Biologeek</a></li>
|
|
|
|
<li><a href="http://filyb.info/">Filyb</a></li>
|
|
|
|
<li><a href="http://www.libert-fr.com">Libert-fr</a></li>
|
|
|
|
<li><a href="http://prendreuncafe.com/blog/">N1k0</a></li>
|
|
|
|
<li><a href="http://ziade.org/blog">Tarek Ziadé</a></li>
|
|
|
|
<li><a href="http://zubin71.wordpress.com/">Zubin Mithra</a></li>
|
|
|
|
</ul>
|
|
</div><!-- /.blogroll -->
|
|
|
|
|
|
<div class="social">
|
|
<h2>social</h2>
|
|
<ul>
|
|
<li><a href="./feeds/all.atom.xml" rel="alternate">atom feed</a></li>
|
|
|
|
|
|
|
|
<li><a href="http://twitter.com/ametaireau">twitter</a></li>
|
|
|
|
<li><a href="http://lastfm.com/user/akounet">lastfm</a></li>
|
|
|
|
<li><a href="http://github.com/ametaireau">github</a></li>
|
|
|
|
</ul>
|
|
</div><!-- /.social -->
|
|
|
|
</section><!-- /#extras -->
|
|
|
|
<footer id="contentinfo" class="body">
|
|
<address id="about" class="vcard body">
|
|
Proudly powered by <a href="http://alexis.notmyidea.org/pelican/">pelican</a>, which takes great advantages of <a href="http://python.org">python</a>.
|
|
</address><!-- /#about -->
|
|
|
|
<p>The theme is by <a href="http://coding.smashingmagazine.com/2009/08/04/designing-a-html-5-layout-from-scratch/">Smashing Magazine</a>, thanks!</p>
|
|
</footer><!-- /#contentinfo -->
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
var disqus_shortname = 'blog-notmyidea';
|
|
(function () {
|
|
var s = document.createElement('script'); s.async = true;
|
|
s.type = 'text/javascript';
|
|
s.src = 'http://' + disqus_shortname + '.disqus.com/count.js';
|
|
(document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
|
|
}());
|
|
</script>
|
|
|
|
</body>
|
|
</html> |