Setup a dev environment¶
You must develop on top of the git master branch:
git clone https://github.com/spiral-project/ihatemoney.git
Then you need to build your dev environments. Choose your way…
The quick way¶
If System Requirements are fulfilled, you can just issue:
It will setup a virtualenv, install dependencies, and run the test server.
The hard way¶
Alternatively, you can also use the requirements.txt file to install the dependencies yourself. That would be:
pip install -r requirements.txt
And then run the application:
cd ihatemoney python run.py
Accessing dev server¶
In any case, you can point your browser at http://localhost:5000. It’s as simple as that!
In case you want to update to newer versions (from git), you can just run the “update” command:
It is better to actually turn the debugging mode on when you’re developing.
You can create a
settings.cfg file, with the following content:
DEBUG = True SQLACHEMY_ECHO = DEBUG
You can also set the TESTING flag to True so no mails are sent (and no exception is raised) while you’re on development mode. Then before running the application, declare its path with
$ export IHATEMONEY_SETTINGS_FILE_PATH="$(pwd)/settings.cfg"
How to contribute¶
You would like to contribute? First, thanks a bunch! This project is a small project with just a few people behind it, so any help is appreciated!
There are different ways to help us, regarding if you are a designer, a developer or an user.
As a developer¶
If you want to contribute code, you can write it and then issue a pull request on github. Please, think about updating and running the tests before asking for a pull request as it will help us to maintain the code clean and running.
To do so:
$ make test
As a designer / Front-end developer¶
Feel free to provide us mockups or to involve yourself into the discussions hapenning on the github issue tracker. All ideas are welcome. Of course, if you know how to implement them, feel free to fork and make a pull request.
How to build the documentation ?¶
Install doc dependencies (within the virtualenv, if any):
pip install -r docs/requirements.txt
And to produce html doc in docs/_output folder:
cd docs/ make html
How to release?¶
In order to prepare a new release, we are following the following steps:
- Merge remaining pull requests;
CHANGELOG.rstwith the last changes;
- Update known good versions of dependencies in
requirements.txtwith this command (from inside the venv):
$ pip freeze | grep -v -- '-e' > requirements.txt
Once this is done, use the “release” instruction:
$ make release
And the new version should be published on PyPI.