tag:blogger.com,1999:blog-4477131926658044957.post143689920387307068..comments2023-05-28T03:47:58.240-07:00Comments on pydanny: Evaluating which package to usepydannyhttp://www.blogger.com/profile/00481523876497446983noreply@blogger.comBlogger14125tag:blogger.com,1999:blog-4477131926658044957.post-11672396783239808772011-12-19T12:24:28.961-08:002011-12-19T12:24:28.961-08:00Oh. I was completely unaware of upload_sphinx! Awe...Oh. I was completely unaware of upload_sphinx! Awesome!Richard Joneshttps://www.blogger.com/profile/04600262656208358816noreply@blogger.comtag:blogger.com,1999:blog-4477131926658044957.post-31718564886407533862011-12-19T12:13:48.377-08:002011-12-19T12:13:48.377-08:00Danny, I've tried to follow good current pract...Danny, I've tried to follow good current practices for walkdir, shell-command and contextlib2. The only dodgy thing I'm aware of is that I need to sort out their trove classifiers.Anonymoushttps://www.blogger.com/profile/14824694805745746190noreply@blogger.comtag:blogger.com,1999:blog-4477131926658044957.post-72311653471268786792011-12-19T09:47:26.360-08:002011-12-19T09:47:26.360-08:00pythonpackages.com aims to help with some of this ...pythonpackages.com aims to help with some of this e.g. discovering where the docs are:<br /><br />- http://pythonpackages.com/info/blessings (python.org)<br /><br />- http://127.0.0.1:6543/info/django (rtfd.org)<br /><br />It also displays grid info from opencomparison.org :-)Alex Clarkhttps://www.blogger.com/profile/11612909047373617380noreply@blogger.comtag:blogger.com,1999:blog-4477131926658044957.post-48518299826408810932011-12-19T09:46:24.187-08:002011-12-19T09:46:24.187-08:00OK I have some answers to some of these issues:
A...OK I have some answers to some of these issues:<br /><br />Answer #1: I am stupid. For some reason it works so I can only imagine that I was seeing the "default" theme being different (http://readthedocs.org/docs/alembic/en/latest/index.html)<br /><br />Answer #2. I am (mostly) stupid. There's a link "Upload a Zip file of HTML" which appears to be compatible with the upload_docs feature. But I don't see this mentioned in the docs at http://read-the-docs.readthedocs.org/en/latest/index.html , so this should all be laid out clearly.<br /><br />Answer #4. I am over 40 (sorry, some of us can't help this issue). I see the "docs" link is way at the bottom, in the footer, in a very pale color vs. the background. Put this up at the top with the buttons please!mike bayerhttps://www.blogger.com/profile/01417862951114999907noreply@blogger.comtag:blogger.com,1999:blog-4477131926658044957.post-26110201492152634862011-12-18T18:18:28.068-08:002011-12-18T18:18:28.068-08:00here are my not-yet-resolved issues with readthedo...here are my not-yet-resolved issues with readthedocs (why my small stuff is still on packages.python.org, large stuff still self-hosted):<br /><br />1. it doesn't use my selected Sphinx theme (somehow Pyramid gets it to do it, but I shouldn't have to email/get special permission for this)<br /><br />2. I *like a lot* being able to say "python setup.py upload_docs". I want to put the docs up before I have to commit sometimes (many times). Can I point my --repository flag over to RTD ? <br /><br />3. packages.python.org integrates nicely with pypi. Can't we just get RTD to replace/merge into packages.python.org completely and just have one system ?<br /><br />4. RTD doesn't have easy links to its *own* docs. There's a "get started" link only if I *log out of the site* and pretend I'm brand new. If I log in, this link is gone. It's not on the homepage, it's not on my dashboard. Major omissions like this make me feel a little unconfident about RTD. Such as if my answers to #1 and #2 are actually very simple, well this is why I don't know the answers !<br /><br />5. for my more elaborate docs (i.e. SQLAlchemy) there's a lot of integrations with my regular site i wouldn't want to give up and while I'm sure there's ways to make it all work with fancy client side rendering trickery, it's not worth my time. My site almost never goes down, I get an alert if it does, and when/if I get off of Trac onto Github for issues/source, I'll be able to host the regular site on S3 where it will be mostly bombproof (I could do this now if I just put trac under a different hostname, I guess).<br /><br />That said, for all the little projects I have now (alembic, dogpile, dogpile.cache), I can switch back to RTD if I can get control over themes and the --repository flag.mike bayerhttps://www.blogger.com/profile/01417862951114999907noreply@blogger.comtag:blogger.com,1999:blog-4477131926658044957.post-66308639518047782712011-12-18T14:10:52.631-08:002011-12-18T14:10:52.631-08:00@Kurt - You raise an excellent issue. I'll put...@Kurt - You raise an excellent issue. I'll put out a call for what you are asking, as it would be a great resource for me and every other beginner in Python. :)pydannyhttps://www.blogger.com/profile/00481523876497446983noreply@blogger.comtag:blogger.com,1999:blog-4477131926658044957.post-80164863151897081692011-12-18T14:10:05.614-08:002011-12-18T14:10:05.614-08:00irmin - try out RTFD. It's not just the workfl...irmin - try out RTFD. It's not just the workflow, it's the advanced search and various alternative output methods.pydannyhttps://www.blogger.com/profile/00481523876497446983noreply@blogger.comtag:blogger.com,1999:blog-4477131926658044957.post-89040220683542531482011-12-18T14:08:55.248-08:002011-12-18T14:08:55.248-08:00Cheesecake hasn't been updated in 3 years. The...Cheesecake hasn't been updated in 3 years. The last PyPI release was from over 4 years ago. I bet things have changed in Python too much for it to be of much value now. Also, it fails on so many of the things labeled in this post. ;)pydannyhttps://www.blogger.com/profile/00481523876497446983noreply@blogger.comtag:blogger.com,1999:blog-4477131926658044957.post-30231959282641328072011-12-18T12:44:01.140-08:002011-12-18T12:44:01.140-08:00I'm using sphinx_upload to push my docs to pac...I'm using sphinx_upload to push my docs to packages.python.org in a single command:<br /><br />$ python setup.py build_sphinx upload_sphinx<br /><br />Is rtfd really better than doing it this way?irmenhttps://www.blogger.com/profile/09064218849183324529noreply@blogger.comtag:blogger.com,1999:blog-4477131926658044957.post-28622490208367966082011-12-18T12:01:56.422-08:002011-12-18T12:01:56.422-08:00Cheesecake might actually be useful to determine y...<a href="http://pycheesecake.org/" rel="nofollow">Cheesecake</a> might actually be useful to determine your "distribution value". I couldn't get it to work with Pylint, but otherwise it's a pretty handy tool.Anonymousnoreply@blogger.comtag:blogger.com,1999:blog-4477131926658044957.post-32762221516354174702011-12-18T08:12:48.081-08:002011-12-18T08:12:48.081-08:00So what are some (preferably small) python package...So what are some (preferably small) python packages that you think demonstrate best practices? I'm still trying to catch up on this area before I try to write about it, but people keep asking me for where to look for a demo project to model after and I don't know :)<br /><br />If you'll notice, I never made it to python packaging in my Research Tools class even though it's essential for good collaboration to have great packaging with documentation and testing...<br /><br /><a href="http://vislab-ccom.unh.edu/~schwehr/Classes/2011/esci895-researchtools/" rel="nofollow">http://vislab-ccom.unh.edu/~schwehr/Classes/2011/esci895-researchtools/</a><br /><br />I left the students hanging at kind of a half way point. They are now fully capabable of shooting themselves in the foot, but have no guidance on forward progress.Kurt Schwehrhttps://www.blogger.com/profile/13351499194822132482noreply@blogger.comtag:blogger.com,1999:blog-4477131926658044957.post-89244001238120388752011-12-17T19:47:54.291-08:002011-12-17T19:47:54.291-08:00+1 for rtfd. Martin created the packages.python.or...+1 for rtfd. Martin created the packages.python.org setup before rtfd came along and it was a good substitute for <b>nothing</b> but really RTFD is <b>bloody good</b>. I'm thinking about how feasible it'd be to ping rtfd for package docs and link from pypi. Probably not really, and I'd get in trouble for it eventually I'm sure (<0.5 wink>).Richard Joneshttps://www.blogger.com/profile/04600262656208358816noreply@blogger.comtag:blogger.com,1999:blog-4477131926658044957.post-51182551432391452152011-12-17T19:09:08.899-08:002011-12-17T19:09:08.899-08:00+1, except the Documentation part.+1, <a href="http://kmike.ru/on-package-docs/" rel="nofollow">except the Documentation</a> part.Mikhail Korobovhttps://www.blogger.com/profile/03931103648429594820noreply@blogger.comtag:blogger.com,1999:blog-4477131926658044957.post-62527522341466215752011-12-17T18:36:54.023-08:002011-12-17T18:36:54.023-08:00I'd add a couple more:
- public source control...I'd add a couple more:<br />- public source control<br />- public issue tracker<br /><br />I don't care *which* of the various public services for those a project uses (or even if they host their own), I just want to know that code and bugs are handled in am at least somewhat structured fashion.Anonymoushttps://www.blogger.com/profile/14824694805745746190noreply@blogger.com