mirror of
https://github.com/wger-project/wger.git
synced 2026-02-18 00:17:51 +01:00
3189927f88
Also, move the settings for the pep8 checks from the command line to a configuration file, which is a better solution anyway.
85 lines
3.0 KiB
ReStructuredText
85 lines
3.0 KiB
ReStructuredText
Development
|
|
===========
|
|
|
|
First, install all required packages::
|
|
|
|
$ sudo apt-get install python-virtualenv
|
|
$ sudo apt-get install python-dev
|
|
$ virtualenv python-django
|
|
$ source python-django/bin/activate
|
|
$ pip install -r requirements_devel.txt
|
|
|
|
.. note::
|
|
For python3 some packages have slightly different names such as ``python3-dev``
|
|
|
|
|
|
Get the code and start the application. This will create a SQlite database
|
|
and populate it with data on the first run::
|
|
|
|
$ git clone https://github.com/rolandgeider/wger.git
|
|
$ cd wger
|
|
$ python start.py
|
|
|
|
That's it. You can log in with the default administator user:
|
|
|
|
* **username**: admin
|
|
* **passsword**: admin
|
|
|
|
You can start the application again with the django server with
|
|
``python manage.py runserver``. If you pull updates and there were database changes, you can apply them with a simple ``python manage.py migrate --all``.
|
|
|
|
Tips
|
|
----
|
|
|
|
Moving important files
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The start script places the settings file and the sqlite database in a non
|
|
obvious place. For developement I suggest moving them to the folder with the
|
|
code::
|
|
|
|
$ python start.py --show-config
|
|
Settings file: /home/user/.config/wger/settings.py
|
|
Database file: /home/user/.local/share/wger/database.sqlite
|
|
|
|
mv /home/user/.config/wger/settings.py .
|
|
mv /home/user/.local/share/wger/database.sqlite
|
|
|
|
|
|
Using runserver_plus
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
During development you can use ``runserver_plus`` instead of the default django
|
|
server as you can use an interactive debugger directly from the browser if an
|
|
exception occurs. It also accepts the same command line options. For this just
|
|
install the following packages::
|
|
|
|
pip install django_extensions werkzeug
|
|
python manage.py runserver_plus [options]
|
|
|
|
|
|
Contributing
|
|
------------
|
|
|
|
* **Send pull requests**: for new code you want to share, please send pull
|
|
requests in github. Sending patches by email or attaching them to an issue
|
|
means a lot more of work. It's recommended that you work on a feature branch
|
|
when working on something, specially when it's something bigger. While many
|
|
people insist on rebasing before sending a pull request, it's not necessary.
|
|
|
|
* **Run the tests**: wger is proud to have a test coverage of over 90%. When you
|
|
implement something new, don't forget to run the testsuite and write approriate
|
|
tests for the new code. If you use github, configure the awesome Travis CI, there
|
|
is already a .travis file in the sources.
|
|
|
|
* **Code according to PEP8**: check that the code is structured as per pep8 but
|
|
with a maximum line length of 100. This can be checked automatically with the
|
|
pep8 tool (pip install pep8) from the command line (travis will do this as part
|
|
of the tests): ``pep8 wger``
|
|
|
|
* **code for python3**: while the application should remain compatible with
|
|
python2, use django's suggestion to mantain sanity: code for py3 and treat
|
|
py2 as a backwards compatibility requirement. If you need, you can use six.
|
|
|
|
For other ways of contributing besides code, you might want to take a look at the contribute page.
|