1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
|
.. _development:
===========
Development
===========
You can help developing PyMySQL by `contributing on GitHub`_.
.. _contributing on GitHub: https://github.com/PyMySQL/PyMySQL
Building the documentation
--------------------------
Go to the ``docs`` directory and run ``make html``.
Test Suite
-----------
If you would like to run the test suite, create database for test like this::
mysql -e 'create database test_pymysql DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;'
mysql -e 'create database test_pymysql2 DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;'
Then, copy the file ``.travis.databases.json`` to ``pymysql/tests/databases.json``
and edit the new file to match your MySQL configuration::
$ cp .travis.databases.json pymysql/tests/databases.json
$ $EDITOR pymysql/tests/databases.json
To run all the tests, execute the script ``runtests.py``::
$ python runtests.py
A ``tox.ini`` file is also provided for conveniently running tests on multiple
Python versions::
$ tox
|