Install Gourmet's dependencies:
pip3 install -r requirements.txt
pip3 install -r development.txt
requirements.txt contains the dependencies needed for Gourmet itself,
development.txt contains the packages required for testing.
Before you start development, you should first build localized *.mo and *.gourmet-plugin files within a build/ subdirectory of the source tree by running
python3 setup.py build_i18n
You can then install Gourmet in edit mode so:
pip3 install --user -e .
By doing so, you will be able to test your changes when launching Gourmet.
New code follows the PEP 8 standard.
The following conventions are not strictly followed in Gourmet, old code should be reformatted only when modifying it.
Gourmet's source code is hosted on GitHub. You can clone it by opening a command prompt and typing:
git clone https://github.com/thinkle/gourmet.git
If you don't have any previous experience with Git, you might want to take a look at the official Git tutorial, or the GitHub Help pages.
If you'd like to contribute,
- fork and clone the repository
- pick an issue to work on
- post a little comment expressing your intent to make sure nobody else is already working on it
- hack the code, and when ready
- push to your forked repo, and create a pull request.
Make sure to also check out our upcoming milestones.
We welcome feedback and issue reporting. You can do so by browsing existing issues and commenting on them, or creating a new one.
When reporting an issue, please fill in the provided template.
For feedback or requests of features, please explain with details, and screenshots if possible, what you would like.