Thoughts on PyFCP

--===============0941600319==
Content-Type: multipart/alternative; boundary=047d7bd6b9ba3d628304eb27752c

--047d7bd6b9ba3d628304eb27752c
Content-Type: text/plain; charset=ISO-8859-1

I was browsing around Freenet's github profile this morning and ran across
PyFCP (lib-pyFreenet).  There were a few things that immediately jumped out
to me as projects I could work on, but given their scope I figured I'd get
some feedback before investing the effort.

First, I'd like to convert the documentation from epydoc to sphinx.  Sphinx
is much prettier by default, has a number of great themes, is not dead
(Epydoc's last release was almost six years ago!), lends itself to
user-documentation (not just API docs), and is supported by Read the Docs,
a fantastic documentation project that has become the standard for Python
projects.

Secondly, the package is in actuality many different things, tied together
merely by subject (Freenet) and implementation language (Python); a good
half of the readme is a description of the various projects.  Why should
someone wanting to work with the Freenet protocol in Python need to install
an IRC bot, or an XML-RPC server?  A split should, of course, consist of a
number of forks from the current HEAD, so as to maintain revision history
for each project.

(BTW, the 'requires' argument is misspelled 'requries' in the setup.py; I
imagine setuptools would complain about this any time you attempt to build
the package.)
(BTW #2, what is the point of having separate -official and -staging
repositories?  Is this not the point of branches?)

My apologies if this is stepping on any toes; I'm not at all familiar with
the development history of Freenet or PyFCP, so I am relying upon you to
point out any reasons things should stay as they are.

Happy anonymity,
 - James

--047d7bd6b9ba3d628304eb27752c
Content-Type: text/html; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr">I was browsing around Freenet&#39;s github profile this mo=
rning and ran across PyFCP (lib-pyFreenet). =A0There were a few things that=
 immediately jumped out to me as projects I could work on, but given their =
scope I figured I&#39;d get some feedback before investing the effort.<div>

<br></div><div>First, I&#39;d like to convert the documentation from epydoc=
 to sphinx. =A0Sphinx is much prettier by default, has a number of great th=
emes, is not dead (Epydoc&#39;s last release was almost six years ago!), le=
nds itself to user-documentation (not just API docs), and is supported by R=
ead the Docs, a fantastic documentation project that has become the standar=
d for Python projects.</div>

<div><br></div><div>Secondly, the package is in actuality many different th=
ings, tied together merely by subject (Freenet) and implementation language=
 (Python); a good half of the readme is a description of the various projec=
ts. =A0Why should someone wanting to work with the Freenet protocol in Pyth=
on need to install an IRC bot, or an XML-RPC server? =A0A split should, of =
course, consist of a number of forks from the current HEAD, so as to mainta=
in revision history for each project.</div>

<div><br></div><div>(BTW, the &#39;requires&#39; argument is misspelled &#3=
9;requries&#39; in the setup.py; I imagine setuptools would complain about =
this any time you attempt to build the package.)</div><div>(BTW #2, what is=
 the point of having separate -official and -staging repositories? =A0Is th=
is not the point of branches?)</div>

<div><br></div><div>My apologies if this is stepping on any toes; I&#39;m n=
ot at all familiar with the development history of Freenet or PyFCP, so I a=
m relying upon you to point out any reasons things should stay as they are.=
</div>

<div><br></div><div>Happy anonymity,</div><div>=A0- James</div></div>

--047d7bd6b9ba3d628304eb27752c--

--===============0941600319==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
Tech mailing list
[email protected]
https://emu.freenetproject.org/cgi-bin/mailman/listinfo/tech
--===============0941600319==--