https://github.com/secnot/django-isbn-field
Django model field to store and validate ISBN numbers.
https://github.com/secnot/django-isbn-field
django field isbn
Last synced: 5 months ago
JSON representation
Django model field to store and validate ISBN numbers.
- Host: GitHub
- URL: https://github.com/secnot/django-isbn-field
- Owner: secnot
- License: lgpl-3.0
- Created: 2016-12-11T01:42:31.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-03-14T16:33:29.000Z (about 3 years ago)
- Last Synced: 2025-09-30T13:27:02.628Z (9 months ago)
- Topics: django, field, isbn
- Language: Python
- Homepage:
- Size: 45.9 KB
- Stars: 24
- Watchers: 4
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# django-isbn-field [](https://github.com/secnot/django-isbn-field/actions)
Provides django model field to store and validate ISBN numbers.
## Requirements
It has been tested on
* Python >= 3.6
* Django 2.2, 3.3, 4.0
## Installation
From Pypi
```bash
$ pip install django-isbn-field
```
or from the repository
```bash
$ git clone https://github.com/secnot/django-isbn-field
$ python setup.py install
```
## Usage
Add isbn_field to INSTALLED_APPS
```python
# settings.py
INSTALLED_APPS = (
...
'isbn_field',
)
```
Use the field in your model
```python
from django.db import models
from isbn_field import ISBNField
class Book(models.Model):
isbn = ISBNField()
...
```
It will raise a ValidationError when the number provided is invalid.
Further, by default any entered ISBN will be cleaned (dashes and spaces are removed) and stored in this canonical form. You can disable this and store the original form through the `clean_isbn` flag.
```python
from django.db import models
from isbn_field import ISBNField
class Book(models.Model):
dirty_isbn = ISBNField(clean_isbn=False)
...
```
In case you expect very chaotic input (e.g. more than one space or dash between digits), you might also want to increase the `max_length` of the field to allow for enough room for the string in the database.