Cheesecake for all

9 02 2007

If you maintain a Python package that is registered on PyPI, go check out Cheesecake service now! We automatically test new releases, so if you have released a new version of your code recently, you can check its Cheesecake score right away.

Tasty cheesecake photo by Sharyn Morrow

Cheesecake is a tool that gives you feedback about state of your python package. Unit testing gives you feedback about behaviour of your code, while Cheesecake tells you about such things like whenever your package can be easily installed, how well it is documented and how strictly your code adheres to common coding standards (like PEP-8).

Cheesecake defines three types of indexes: installability, documentation and code kwalitee index. In short, installability tells you if your package can be easily found, downloaded and installed using distutils/setuptools facilities. Documentation index informs you how many of your code objects (modules/classes/functions) have docstrings and did you remember to create files like README or INSTALL (which users tend to look for first after unpacking the source). Code kwalitee checks your unit tests and runs pylint on the whole package. If you combine all of those different aspects of a package and check their conformance to a common practice – you get Cheesecake score. Want more details? Check out description of an algorithm for computing the Cheesecake index.

Score isn’t meant to define “better” and “worse” packages, it is only a helpful estimate of progress, as you make certain efforts to make your package easier to install, understand and modify. More work you put into your distribution, higher Cheesecake score you should get. We tried hard to make this correlation of good packaging practice and Cheesecake score high, but chances are we made some mistakes. If you think we scored some parts of your package wrongly or we missed some effort, we urge you to send us a bug report. The whole Python community will benefit, as the definition of a good Python package is still not well crystallized. We want Cheesecake to be a useful tool for all Python programmers who seek guidance on how to improve their distributions. The profit is mutual – developer can raise his knowledge of good coding practices and potential distribution problems, while his improved package will get used more often for the benefit of whole Python community.

So, check out Cheesecake service or try Cheesecake on your computer. Bon Appétit!

About these ads

Actions

Information

3 responses

9 02 2007
What’s Chris Doing? » Blog Archive » The Cheesecake Service

[…] Part of Michał Kwiatkowski’s Summer of Code project was the to create the Cheesecake service. Micheal explains how it all works in his announcement of the cheesecake service. […]

11 02 2007
Sharad

Hi…

Neat – a ‘mechanism’ that guides and encourages relevant ‘good practices’ is a great idea!

As the definition of a good python package crystallizes, I guess we should also keep in mind that practices change and evolve over time (hopefully for the better) and sometimes ‘good quality’ can be a moving target. The mechanism itself must also evolve to reflect those, lest it becomes a limiting block.

Having said that, may our Cheesecakes score high and may we never suffer from indigestion… ;)

11 02 2007
mousebender

We’re constantly seeking feedback, so we can keep Cheesecake score truly relevant, and not a bunch of rules that couple of guys invented. Integration with PyPI is part of that – by testing our features on real world Python software we can make sure we’re doing it right.

Thanks for the comment.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s




Follow

Get every new post delivered to your Inbox.

%d bloggers like this: