summaryrefslogtreecommitdiff
path: root/doc/django.rst
blob: 5fc65f89e01b27810af68dfcab5d206cfc7ddd71 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Interaction with Django
=======================

.. module:: semantic_version.django_fields

The ``python-semanticversion`` package provides two custom fields for Django:

- :class:`VersionField`: stores a :class:`semantic_version.Version` object
- :class:`SpecField`: stores a :class:`semantic_version.Spec` object


.. class:: VersionField

    Stores a :class:`semantic_version.Version`.

    .. attribute:: partial

        Boolean; whether :attr:`~semantic_version.Version.partial` versions are allowed.


.. class:: SpecField

    Stores a :class:`semantic_version.Spec`.