Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated README #135

Merged
merged 2 commits into from
Jun 27, 2019
Merged

Updated README #135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cf223d
Updated README
clintonb Jun 27, 2019
aee56d6
Added contributor doc
clintonb Jun 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 27 additions & 25 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@ Changelog

1.5.1 (in development)
----------------------
* `#135`_ Updated README with Jazzband details, and added CONTRIBUTING.md
* `#136`_ Dropped support for Python 2.6 and 3.3, and Django < 1.11

.. _#136: https://github.com/gregmuellegger/django-sortedm2m/pull/136
.. _#135: https://github.com/jazzband/django-sortedm2m/pull/135
.. _#136: https://github.com/jazzband/django-sortedm2m/pull/136

1.5.0
-----
Expand All @@ -15,8 +17,8 @@ Changelog
* `#87`_: Fix ``AlterSortedManyToManyField`` operation to support custom set
``_sort_field_name``.

.. _#101: https://github.com/gregmuellegger/django-sortedm2m/pull/101
.. _#87: https://github.com/gregmuellegger/django-sortedm2m/issues/87
.. _#101: https://github.com/jazzband/django-sortedm2m/pull/101
.. _#87: https://github.com/jazzband/django-sortedm2m/issues/87

1.4.0
-----
Expand All @@ -29,36 +31,36 @@ Changelog
``ManyToManyField`` instead of ``SortedManyToManyField`` from ``sortedm2m``.
Thanks Dayne May for the patch.

.. _#104: https://github.com/gregmuellegger/django-sortedm2m/pull/104
.. _#94: https://github.com/gregmuellegger/django-sortedm2m/pull/94
.. _#93: https://github.com/gregmuellegger/django-sortedm2m/pull/93
.. _#104: https://github.com/jazzband/django-sortedm2m/pull/104
.. _#94: https://github.com/jazzband/django-sortedm2m/pull/94
.. _#93: https://github.com/jazzband/django-sortedm2m/pull/93

1.3.3
-----

* `#91`_ & `#92`_: Fix admin widget, when used with Django 1.10. The add a new
item opup was not closing. Thanks to Tipuch for the patch.

.. _#91: https://github.com/gregmuellegger/django-sortedm2m/issues/91
.. _#92: https://github.com/gregmuellegger/django-sortedm2m/pull/92
.. _#91: https://github.com/jazzband/django-sortedm2m/issues/91
.. _#92: https://github.com/jazzband/django-sortedm2m/pull/92

1.3.2
-----

* `#80`_ & `#83`_: Fix ``SortedMultipleChoiceField.clean`` if the validated
value is ``None``. Thanks to Alex Mannhold for the patch.

.. _#80: https://github.com/gregmuellegger/django-sortedm2m/issues/80
.. _#83: https://github.com/gregmuellegger/django-sortedm2m/pull/83
.. _#80: https://github.com/jazzband/django-sortedm2m/issues/80
.. _#83: https://github.com/jazzband/django-sortedm2m/pull/83

1.3.1
-----

* `#57`_ & `#81`_: Fix add related object popup error prevents operation when
no related objects already exist. Thanks to Vadim Sikora for the fix.

.. _#57: https://github.com/gregmuellegger/django-sortedm2m/issue/57
.. _#81: https://github.com/gregmuellegger/django-sortedm2m/pull/81
.. _#57: https://github.com/jazzband/django-sortedm2m/issue/57
.. _#81: https://github.com/jazzband/django-sortedm2m/pull/81

1.3.0
-----
Expand All @@ -74,16 +76,16 @@ Changelog
* `#76`_: Add support for to_field_name to SortedMultipleChoiceField. Thanks
to Conrad Kramer for the patch.

.. _#76: https://github.com/gregmuellegger/django-sortedm2m/pull/76
.. _#79: https://github.com/gregmuellegger/django-sortedm2m/pull/79
.. _#76: https://github.com/jazzband/django-sortedm2m/pull/76
.. _#79: https://github.com/jazzband/django-sortedm2m/pull/79

1.2.2
-----

* `#75`_: Fix "add another" admin popup. It didn't refresh the list of items in Django
1.8+. Thanks to Vadim Sikora for the patch.

.. _#75: https://github.com/gregmuellegger/django-sortedm2m/pull/75
.. _#75: https://github.com/jazzband/django-sortedm2m/pull/75

1.2.1
-----
Expand All @@ -103,15 +105,15 @@ Changelog
``SortedCheckboxSelectMultiple``. Thanks to Kirill Ermolov for the
patch.

.. _#71: https://github.com/gregmuellegger/django-sortedm2m/issues/71
.. _#71: https://github.com/jazzband/django-sortedm2m/issues/71

1.1.1
-----

* `#70`_: CSS fix for Django 1.9 new admin design. Thanks to Maarten Draijer
for the patch.

.. _#70: https://github.com/gregmuellegger/django-sortedm2m/pull/70
.. _#70: https://github.com/jazzband/django-sortedm2m/pull/70

1.1.0
-----
Expand All @@ -122,10 +124,10 @@ Changelog
decided by Django's DB router (with the ``allow_migrate_model`` method).
Thanks to @hstanev for the patch.

.. _#59: https://github.com/gregmuellegger/django-sortedm2m/pull/59
.. _#65: https://github.com/gregmuellegger/django-sortedm2m/pull/65
.. _#67: https://github.com/gregmuellegger/django-sortedm2m/pull/67
.. _#68: https://github.com/gregmuellegger/django-sortedm2m/pull/68
.. _#59: https://github.com/jazzband/django-sortedm2m/pull/59
.. _#65: https://github.com/jazzband/django-sortedm2m/pull/65
.. _#67: https://github.com/jazzband/django-sortedm2m/pull/67
.. _#68: https://github.com/jazzband/django-sortedm2m/pull/68

1.0.2
-----
Expand All @@ -136,15 +138,15 @@ Changelog
added objects will be in order. Thanks to Scott Kyle for the report and
patch.

.. _#56: https://github.com/gregmuellegger/django-sortedm2m/pull/56
.. _#56: https://github.com/jazzband/django-sortedm2m/pull/56

1.0.1
-----

* Performance fix for sorted m2m admin widget. See `#54`_ for details. Thanks
to Jonathan Liuti for fixing this.

.. _#54: https://github.com/gregmuellegger/django-sortedm2m/pull/54
.. _#54: https://github.com/jazzband/django-sortedm2m/pull/54

1.0.0
-----
Expand All @@ -166,15 +168,15 @@ Changelog
``sort_value_field_name`` in Django 1.7 migrations. Thanks to Christian
Kohlstedde for the patch.

.. _#49: https://github.com/gregmuellegger/django-sortedm2m/issues/49
.. _#49: https://github.com/jazzband/django-sortedm2m/issues/49

0.9.5
-----

* Fixing ``setup.py`` when run on a system that does not use UTF-8 as default
encoding. See `#48`_ for details. Thanks to Richard Mitchell for the patch.

.. _#48: https://github.com/gregmuellegger/django-sortedm2m/pull/48
.. _#48: https://github.com/jazzband/django-sortedm2m/pull/48

0.9.4
-----
Expand Down
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[![Jazzband](https://jazzband.co/static/img/jazzband.svg)](https://jazzband.co/)

This is a [Jazzband](https://jazzband.co/) project. By contributing you agree to abide by the [Contributor Code of Conduct](https://jazzband.co/about/conduct) and follow the [guidelines](https://jazzband.co/about/guidelines).
42 changes: 19 additions & 23 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,25 @@
django-sortedm2m
================

|pypi-badge| |build-status|
.. image:: https://jazzband.co/static/img/badge.svg
:target: https://jazzband.co/
:alt: Jazzband

.. image:: https://img.shields.io/pypi/v/django-sortedm2m.svg
:target: https://pypi.python.org/pypi/django-sortedm2m
:alt: PyPI Release

.. image:: https://travis-ci.org/jazzband/django-sortedm2m.svg?branch=master
:target: https://travis-ci.org/jazzband/django-sortedm2m
:alt: Build Status


``sortedm2m`` is a drop-in replacement for django's own ``ManyToManyField``.
The provided ``SortedManyToManyField`` behaves like the original one but
remembers the order of added relations.

Usecases
========
Use Cases
=========

Imagine that you have a gallery model and a photo model. Usually you want a
relation between these models so you can add multiple photos to one gallery
Expand Down Expand Up @@ -161,11 +172,13 @@ Example::

Contribute
==========
This is a `Jazzband <https://jazzband.co>`_ project. By contributing you agree to abide by the
`Contributor Code of Conduct <https://jazzband.co/about/conduct>`_ and follow the
`guidelines <https://jazzband.co/about/guidelines>`_.

You can find the latest development version on github_. Get there and fork it,
file bugs or send me nice wishes.
You can find the latest development version on Github_. Get there and fork it, file bugs or send well wishes.

.. _github: http://github.com/gregmuellegger/django-sortedm2m
.. _github: http://github.com/jazzband/django-sortedm2m

Running the tests
-----------------
Expand All @@ -188,20 +201,3 @@ against a PostgreSQL database.

.. _vagrant: http://www.vagrantup.com/
.. _install vagrant: http://www.vagrantup.com/downloads

Get in touch
------------

Feel free to drop me a message about critique or feature requests. You can get
in touch with me by mail_ or twitter_.

.. _mail: mailto:gregor@muellegger.de
.. _twitter: http://twitter.com/gregmuellegger

.. |pypi-badge| image:: https://img.shields.io/pypi/v/django-sortedm2m.svg
:alt: PyPI Release
:target: https://pypi.python.org/pypi/django-sortedm2m

.. |build-status| image:: https://travis-ci.org/gregmuellegger/django-sortedm2m.png
:alt: Build Status
:target: https://travis-ci.org/gregmuellegger/django-sortedm2m