librelist archives

« back to archive

development help getting started

development help getting started

From:
Eric Wollesen
Date:
2014-08-29 @ 04:34
Hi,

Is there any documentation to help someone get started hacking on the 
master branch?

I'm working on a new feature, but unfortunately I have a number of test 
failures with a pristine checkout. My python is about ten years rusty, 
but I suspect that most of the errors are due to missing (unstated?) 
python dependencies.

I did figure out that I needed to pip install nose, and I installed the 
packages in requirements.txt.

I'm trying this on Ubuntu Trusty and OSX Mavericks. Both running python 2.7.

Thanks!

e.
-- 
ericw@xmtp.net

Re: [sigal] development help getting started

From:
Simon
Date:
2014-08-29 @ 21:09
Hi,

Le 28/08 22:34, Eric Wollesen à écrit:
> Is there any documentation to help someone get started hacking on the
> master branch?

No, but you're right, I should add some docs about this.


> I'm working on a new feature, but unfortunately I have a number of test
> failures with a pristine checkout. My python is about ten years rusty,
> but I suspect that most of the errors are due to missing (unstated?)
> python dependencies.
>
> I did figure out that I needed to pip install nose, and I installed the
> packages in requirements.txt.

To run the tests you need py.test, it is the only additional dependency
(it is listed in the requirements.txt file, which can be used with pip
install -r). py.test can be used to run the tests (like nose), but
I also use it because it provides useful features to write the tests.

Another useful tool to run the tests is tox, it can run the tests on
multiple versions of python (py27 and py33/py34).


--
Simon