Using a personal library...

Evdude on 2011/02/13 03:43

I've made a pygame/pyopengl 2d renderer and I uploaded it to my google site page and pyweek.org. Being more than a month from competition, would it be legal to use in pyweek?

(log in to comment)

Comments

richard on 2011/02/13 05:07:

Great to see! My concern is that it has some examples but there's no real documentation, making it pretty opaque to any other programmer. If that's not rectified then it's not really acceptable for the challenge.

tartley on 2011/02/13 12:41:

Hey there,

Sounds like we're in pretty much identical circumstances - I just announced my own equivalent library here a few days ago, and I also have work to do to get it documented, and I haven't recently tested on non-Windows platforms.

I plan on generating API reference using Sphynx, adding docstrings until that looks reasonably complete, then adding at least an intro page chatting about the basic ideas of the library, some prominent pointers the the examples.

Maybe we could help each other out by quickly checking over each other's documentation to see whether it is sufficient and makes sense?

Evdude on 2011/02/13 15:55:

@richard: Thanks for the response! So, If I got it well documented before the 30 day point, would it be ok to use?

@tartley: That would be great! I've never done documentation before, so mine might take a little while in coming.

tartley on 2011/02/13 18:37:

Alright. I'll ping you when I get started ('any day now'), maybe we could do stuff in tandem to help each other over any hurdles we come across.

richard on 2011/02/14 05:19:

@Evdude yep, you'd be fine!

Evdude on 2011/02/24 15:27:

Ok, Documented as best I could. The new version is here and here, again. Does this look ok?

richard on 2011/02/24 23:07:

That's great! Kudos awarded :-)

Evdude on 2011/02/24 23:18:

Thanks!

tartley on 2011/02/25 16:15:

That's really great, nice work.

BTW, the .zip format download doesn't work for me. I'm on Windows using either 7z nor Cygwin unzip - both report 'unsupported method LZMA'.

Evdude on 2011/02/25 18:20:

@tartley: That happened to me to! I thought it was because I zipped it on windows and tried to unzip it on linux. I've zipped it on linux and uploaded it again, so hopefully its OK now.

And thank you, by the way :)

ServalKatze on 2011/02/27 13:10:

FYI: We'll be using our own little library (Pykitten), too.

I even tried to write a tutorial for it but I'm kind of bad at explaining things. XD

Download (API documentation included)
Wiki page

tartley on 2011/03/04 15:53:

My own little library, Gloopy, is now documented and on PyPI:
http://pypi.python.org/pypi/gloopy
(Sorry for crossposting)

Strictly speaking I think I'm a day late for the 'month before pyweek' deadline. I had successive Barrys with both Sphinx and setup.py. :-)