Updated testing instructions in contribution and installation guides and bumped version number to 0.18.10 in pyproject.toml.

This commit is contained in:
Benedikt Willi 2023-06-02 14:07:15 +02:00
parent b3debe82d4
commit 00462a8128
4 changed files with 28 additions and 26 deletions

View file

@ -8,6 +8,3 @@ publish: clean
clean:
rm -rf dist
test:
poetry run python ./runtests.py

View file

@ -56,12 +56,17 @@ Python 3 is supported since 0.7 release. Although 0.6 release supported Django 1
Unittests
*********
Modeltranslation has a comprehensive test suite. A test runner is provided which
allows to run the tests outside of a Django project:
To test Modeltranslation, you can use the comprehensive test suite that comes
with the package. First, make sure you have installed the project's requirements
using Poetry. Once the requirements are installed,
you can run the tests using pytest. This will run all of the tests in the test
suite and report any failures or errors.
.. code-block:: console
$ python runtests.py
$ pip install poetry
$ poetry install
$ poetry run pytest
Non trivial changes and new features should always be accompanied by a unittest.
Pull requests which add unittests for uncovered code or rare edge cases are also
@ -71,10 +76,11 @@ appreciated.
Continuous Integration
**********************
The project uses `Travis CI`_ for continuous integration tests. Hooks provided
by Github are active, so that each push and pull request is automatically run
against our `Travis CI config`_, checking code against different databases,
Python and Django versions. This includes automatic tracking of test coverage
The project uses `Github Actions`_ for continuous integration tests. Hooks
provided by Github are active, so that each push and pull request is
automatically run against our `Github Actions Workflows`_, checking code
against different databases, Python and Django versions.
This includes automatic tracking of test coverage
through `Coveralls`_.
.. image:: http://img.shields.io/coveralls/deschler/django-modeltranslation.png?style=flat
@ -117,8 +123,8 @@ Please do not use the issue tracker for general questions, we run a dedicated
.. _pyflakes: https://pypi.python.org/pypi/pyflakes
.. _flake8: https://pypi.python.org/pypi/flake8
.. _Github: https://github.com/deschler/django-modeltranslation
.. _Travis CI: https://travis-ci.org/deschler/django-modeltranslation
.. _Travis CI config: https://github.com/deschler/django-modeltranslation/blob/master/.travis.yml
.. _Github Actions: https://travis-ci.org/deschler/django-modeltranslation
.. _Github Actions Workflows: https://github.com/deschler/django-modeltranslation/blob/master/.github/workflows
.. _Coveralls: https://coveralls.io/r/deschler/django-modeltranslation
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx-doc.org/

View file

@ -8,21 +8,23 @@ Requirements
Which Modeltranslation version is required for given Django-Python combination to work?
======= ==== ==== ==== ==== ==== ==== ==== ==== ====
======= ==== ==== ==== ==== ==== ==== ==== ==== ==== ==== ==== ====
Python Django
------- --------------------------------------- ----
version 1.8 1.9 1.10 1.11 2.0 2.1 2.2 3.0 3.2
======= ==== ==== ==== ==== ==== ==== ==== ==== ====
------- -----------------------------------------------------------
version 1.8 1.9 1.10 1.11 2.0 2.1 2.2 3.0 3.2 4.0 4.1 4.2
======= ==== ==== ==== ==== ==== ==== ==== ==== ==== ==== ==== ====
2.7 |9| |11| |12| |13|
3.2 |9|
3.3 |9|
3.4 |9| |11| |12| |13| |13|
3.5 |9| |11| |12| |13| |13| |13|
3.6 |13| |13| |13| |15| |15| |17|
3.7 |13| |13| |15| |15| |17|
3.8 |13| |13| |15| |15| |17|
3.9 |13| |13| |15| |15| |17|
======= ==== ==== ==== ==== ==== ==== ==== ==== ====
3.6 |13| |13| |13| |15| |15| |17| |17| |17| |18|
3.7 |13| |13| |15| |15| |17| |17| |17| |18|
3.8 |13| |13| |15| |15| |17| |17| |17| |18|
3.9 |13| |13| |15| |15| |17| |17| |17| |18|
3.10 |13| |13| |15| |15| |17| |17| |17| |18|
3.11 |13| |13| |15| |15| |17| |17| |17| |18|
======= ==== ==== ==== ==== ==== ==== ==== ==== ==== ==== ==== ====
(``-X`` denotes "up to version X", whereas ``X+`` means "from version X upwards")
@ -32,6 +34,7 @@ version 1.8 1.9 1.10 1.11 2.0 2.1 2.2 3.0 3.2
.. |13| replace:: 0.13+
.. |15| replace:: 0.15+
.. |17| replace:: 0.17+
.. |18| replace:: 0.18+
Using Pip
---------
@ -78,10 +81,6 @@ in detail in the following sections:
.. note:: This only applies if the models registered in ``translation.py`` haven't been
synced to the database before. If they have, please read :ref:`db-fields`.
.. note:: If you are using Django 1.7 and its internal migration system, run
``python manage.py makemigrations``, followed by
``python manage.py migrate`` instead. See :ref:`migrations` for details.
Configuration
=============

View file

@ -1,6 +1,6 @@
[tool.poetry]
name = "django-modeltranslation"
version = "0.16.1"
version = "0.18.10"
description = "Translates Django models using a registration approach."
authors = ["Peter Eschler <peschler@gmail.com>"]
maintainers = ["Serhii Tereshchenko <serg.partizan@gmail.com>"]