/usr/share/doc/python-rdflib-doc/html/developers.html is in python-rdflib-doc 4.1.2-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>RDFLib developers guide — rdflib 4.1.2 documentation</title>
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"/>
<link rel="stylesheet" href="_static/rtd.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '4.1.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="top" title="rdflib 4.1.2 documentation" href="index.html" />
<link rel="next" title="Writing RDFLib Documentation" href="docs.html" />
<link rel="prev" title="tools Package" href="apidocs/rdflib.tools.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="docs.html" title="Writing RDFLib Documentation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="apidocs/rdflib.tools.html" title="tools Package"
accesskey="P">previous</a> |</li>
<li><a href="index.html">rdflib 4.1.2 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="rdflib-developers-guide">
<h1>RDFLib developers guide<a class="headerlink" href="#rdflib-developers-guide" title="Permalink to this headline">¶</a></h1>
<div class="section" id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>This document describes the process and conventions to follow when
developing RDFLib code.</p>
<p>Please be as Pythonic as possible (<span class="target" id="index-0"></span><a class="pep reference external" href="http://www.python.org/dev/peps/pep-0008"><strong>PEP 8</strong></a>).</p>
<p>Code will occasionally be auto-formatted using <tt class="docutils literal"><span class="pre">autopep8</span></tt> - you can also do this yourself.</p>
<p>Any new functionality being added to RDFLib should have doc tests and
unit tests. Tests should be added for any functionality being changed
that currently does not have any doc tests or unit tests. And all the
tests should be run before committing changes to make sure the changes
did not break anything.</p>
<p>If you add a new cool feature, consider also adding an example in <tt class="docutils literal"><span class="pre">./examples</span></tt></p>
</div>
<div class="section" id="running-tests">
<h2>Running tests<a class="headerlink" href="#running-tests" title="Permalink to this headline">¶</a></h2>
<p>Run tests with <a class="reference external" href="https://nose.readthedocs.org/en/latest/">nose</a>:</p>
<p>Specific tests can either be run by module name or file name. For example:</p>
<div class="highlight-python"><div class="highlight"><pre>$ python run_tests.py --tests rdflib.graph
$ python run_tests.py --tests test/test_graph.py
</pre></div>
</div>
</div>
<div class="section" id="writing-documentation">
<h2>Writing documentation<a class="headerlink" href="#writing-documentation" title="Permalink to this headline">¶</a></h2>
<p>We use sphinx for generating HTML docs, see <a class="reference internal" href="docs.html#docs"><em>Writing RDFLib Documentation</em></a></p>
</div>
<div class="section" id="continous-integration">
<h2>Continous Integration<a class="headerlink" href="#continous-integration" title="Permalink to this headline">¶</a></h2>
<p>We used Travis for CI, see:</p>
<blockquote>
<div><a class="reference external" href="https://travis-ci.org/RDFLib/rdflib">https://travis-ci.org/RDFLib/rdflib</a></div></blockquote>
<p>If you make a pull-request to RDFLib on GitHub, travis will automatically test you code.</p>
</div>
<div class="section" id="compatibility">
<h2>Compatibility<a class="headerlink" href="#compatibility" title="Permalink to this headline">¶</a></h2>
<p>RDFLib>=3.X tries to be compatible with python versions 2.5 - 3</p>
<p>Some of the limitations we’ve come across:</p>
<blockquote>
<div><ul class="simple">
<li>Python 2.5/2.6 has no abstract base classes from collections, such <tt class="docutils literal"><span class="pre">MutableMap</span></tt>, etc.</li>
<li>2.5/2.6 No skipping tests using <tt class="xref py py-mod docutils literal"><span class="pre">unittest</span></tt>, i.e. <tt class="docutils literal"><span class="pre">TestCase.skipTest</span></tt> and decorators are missing => use nose instead</li>
<li>no <tt class="docutils literal"><span class="pre">str.decode('string-escape')</span></tt> in py3</li>
<li>no <tt class="xref py py-mod docutils literal"><span class="pre">json</span></tt> module in 2.5 (install <tt class="docutils literal"><span class="pre">simplejson</span></tt> instead)</li>
<li>no <tt class="docutils literal"><span class="pre">ordereddict</span></tt> in 2.5/2.6 (install <tt class="docutils literal"><span class="pre">ordereddict</span></tt> module)</li>
<li><tt class="xref py py-class docutils literal"><span class="pre">collections.Counter</span></tt> was added in 2.6</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="releasing">
<h2>Releasing<a class="headerlink" href="#releasing" title="Permalink to this headline">¶</a></h2>
<p>Set to-be-released version number in <tt class="file docutils literal"><span class="pre">rdflib/__init__.py</span></tt></p>
<p>Add <tt class="file docutils literal"><span class="pre">CHANGELOG</span></tt> entry.</p>
<p>Commit this change, and tag it with:</p>
<div class="highlight-python"><div class="highlight"><pre>git tag -a -m 'tagged version' X.X.X
</pre></div>
</div>
<p>When pushing, remember to do:</p>
<div class="highlight-python"><div class="highlight"><pre>git push --tags
</pre></div>
</div>
<p>Upload tarball to pypi with:</p>
<div class="highlight-python"><div class="highlight"><pre>python setup.py sdist upload
</pre></div>
</div>
<p>Set new dev version number in the above locations, i.e. next release <cite>-dev</cite>: <tt class="docutils literal"><span class="pre">8.9.2-dev</span></tt> and commit again.</p>
<p>Update the topic of #rdflib on freenode irc:</p>
<div class="highlight-python"><div class="highlight"><pre>/msg ChanServ topic #rdflib https://github.com/RDFLib/rdflib | latest stable version: 4.0.1 | docs: http://readthedocs.org/docs/rdflib
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/logo.svg" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">RDFLib developers guide</a><ul>
<li><a class="reference internal" href="#introduction">Introduction</a></li>
<li><a class="reference internal" href="#running-tests">Running tests</a></li>
<li><a class="reference internal" href="#writing-documentation">Writing documentation</a></li>
<li><a class="reference internal" href="#continous-integration">Continous Integration</a></li>
<li><a class="reference internal" href="#compatibility">Compatibility</a></li>
<li><a class="reference internal" href="#releasing">Releasing</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="apidocs/rdflib.tools.html"
title="previous chapter">tools Package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="docs.html"
title="next chapter">Writing RDFLib Documentation</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/developers.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="docs.html" title="Writing RDFLib Documentation"
>next</a> |</li>
<li class="right" >
<a href="apidocs/rdflib.tools.html" title="tools Package"
>previous</a> |</li>
<li><a href="index.html">rdflib 4.1.2 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009 - 2013, RDFLib Team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2.2.
<br />Theme based on <a href="http://readthedocs.org/">Read The Docs</a>
</div>
</body>
</html>
|