django-clone


Namedjango-clone JSON
Version 5.3.3 PyPI version JSON
download
home_pagehttps://github.com/tj-django/django-clone.git
SummaryCreate a clone of a django model instance.
upload_time2023-06-12 13:09:22
maintainerTonye Jack
docs_urlNone
authorTonye Jack
requires_python>=3.6
licenseMIT/Apache-2.0
keywords django django-clone django clone django object clone clone-django model cloning django instance duplication django duplication
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            <p align="center"> 
    <img width="466" alt="4FC889E9-FF59-4E44-9EB6-2AF7DC034C74" src="https://user-images.githubusercontent.com/17484350/215616634-17439a58-7bd8-4e9c-989f-e6bef7c73e48.png">
</p>

|  Python   | Django  |  Downloads  |   Code Style   |
|:---------:|:-------:|:-----------:|:--------------:|
| [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django_clone.svg)](https://pypi.org/project/django-clone) | [![PyPI - Django Version](https://img.shields.io/pypi/djversions/django_clone.svg)](https://docs.djangoproject.com/en/dev/releases/) | [![Downloads](https://pepy.tech/badge/django-clone)](https://pepy.tech/project/django-clone) | [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) |

|    PyPI         | Test | Vulnerabilities | Coverage | Code Quality  |  Pre-Commit   |
|:---------------:|:----:|:---------------:|:--------:|:-------------:|:-------------:|
| [![PyPI version](https://badge.fury.io/py/django-clone.svg)](https://badge.fury.io/py/django-clone) | [![Test](https://github.com/tj-django/django-clone/workflows/Test/badge.svg)](https://github.com/tj-django/django-clone/actions?query=workflow%3ATest) | [![Known Vulnerabilities](https://snyk.io/test/github/tj-django/django-clone/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/tj-django/django-clone?targetFile=requirements.txt) | [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/b33dd02dbb034d7fa9886a99f5383ea6)](https://www.codacy.com/gh/tj-django/django-clone?utm_source=github.com\&utm_medium=referral\&utm_content=tj-django/django-clone\&utm_campaign=Badge_Coverage) <br/> [![codecov](https://codecov.io/gh/tj-django/django-clone/branch/main/graph/badge.svg?token=2NE21Oe50Q)](https://codecov.io/gh/tj-django/django-clone)| [![Codacy Badge](https://app.codacy.com/project/badge/Grade/b33dd02dbb034d7fa9886a99f5383ea6)](https://www.codacy.com/gh/tj-django/django-clone?utm_source=github.com\&utm_medium=referral\&utm_content=tj-django/django-clone\&utm_campaign=Badge_Grade) |  [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/tj-django/django-clone/main.svg)](https://results.pre-commit.ci/latest/github/tj-django/django-clone/main) |

## django-clone

Create copies of a model instance with explicit control on how the instance should be duplicated (limiting fields or related objects copied) with unique field detection.

This solves the problem introduced by using `instance.pk = None` and `instance.save()` which results in copying more object state than required.

## Features

*   100% test coverage.
*   More control over how a model instance should be duplicated
*   Multi Database support i.e Create duplicates on one or more databases.
*   Restrict fields used for creating a duplicate instance.
*   Detects unique fields and naively adds a suffix `copy {count}` to each duplicate instance (for supported fields only).
*   Optionally differentiate between a duplicate instance and the original by appending a **copy** suffix to non unique fields (for supported fields only).

## Table of Contents

*   [Installation](#installation)
    *   [pip](#pip)
    *   [poetry](#poetry)
*   [Usage](#usage)
    *   [Subclassing the `CloneModel`](#subclassing-the-clonemodel)
    *   [Using the `CloneMixin`](#using-the-clonemixin)
    *   [Duplicating a model instance](#duplicating-a-model-instance)
    *   [Bulk cloning a model](#bulk-cloning-a-model)
    *   [Creating clones without subclassing `CloneMixin`.](#creating-clones-without-subclassing-clonemixin)
    *   [CloneMixin attributes](#clonemixin-attributes)
        *   [Explicit (include only these fields)](#explicit-include-only-these-fields)
        *   [Implicit (include all except these fields)](#implicit-include-all-except-these-fields)
    *   [Django Admin](#django-admin)
        *   [Duplicating Models from the Django Admin view.](#duplicating-models-from-the-django-admin-view)
            *   [List View](#list-view)
            *   [Change View](#change-view)
        *   [CloneModelAdmin class attributes](#clonemodeladmin-class-attributes)
*   [Advanced Usage](#advanced-usage)
    *   [Signals](#signals)
        *   [pre\_clone\_save, post\_clone\_save](#pre_clone_save-post_clone_save)
    *   [Clone Many to Many fields](#clone-many-to-many-fields)
        *   [Using the `CloneModel`](#using-the-clonemodel)
        *   [Using the `CloneMixin`](#using-the-clonemixin-1)
    *   [Multi database support](#multi-database-support)
*   [Compatibility](#compatibility)
*   [Running locally](#running-locally)
*   [Found a Bug?](#found-a-bug)
*   [Contributors ✨](#contributors-)

## Installation

### pip

```bash
pip install django-clone
```

### poetry

```bash
poetry add django-clone
```

## Usage

### Subclassing the `CloneModel`

![](https://user-images.githubusercontent.com/17484350/221387430-efd5508a-2597-4320-9750-5a4c56833edb.png)

### Using the `CloneMixin`

![](https://user-images.githubusercontent.com/17484350/221387397-6ad5475b-6887-4a5f-b6d3-42784f9dfa7c.png)

### Duplicating a model instance

![](https://user-images.githubusercontent.com/17484350/221386600-731a6f45-1704-4834-bcbe-0f57d912faf7.png)

### Bulk cloning a model

![](https://user-images.githubusercontent.com/17484350/221386555-13978280-35a1-4941-8186-a1c6723a0346.png)

### Creating clones without subclassing `CloneMixin`.

> **NOTE:** :warning:
>
> *   This method won't copy over related objects like Many to Many/One to Many relationships.
> *   Ensure that required fields skipped from being cloned are passed in using the `attrs` kwargs.

![](https://user-images.githubusercontent.com/17484350/221385171-add1a0c3-21fc-4c48-bfe9-4f2014ffe035.png)

### CloneMixin attributes

|    Attribute        |  Description |
|:------------------------------:|:------------:|
| `DUPLICATE_SUFFIX` | Suffix to append to duplicates <br> (NOTE: This requires `USE_DUPLICATE_SUFFIX_FOR_NON_UNIQUE_FIELDS` <br> to be enabled and supports string fields). |
`USE_DUPLICATE_SUFFIX_FOR_NON_UNIQUE_FIELDS` | Enable appending the `DUPLICATE_SUFFIX` to new cloned instances. |
`UNIQUE_DUPLICATE_SUFFIX` | Suffix to append to unique fields |
`USE_UNIQUE_DUPLICATE_SUFFIX` | Enable appending the `UNIQUE_DUPLICATE_SUFFIX` to new cloned instances. |
`MAX_UNIQUE_DUPLICATE_QUERY_ATTEMPTS` | The max query attempt while generating unique values for a case of unique conflicts. |

#### Explicit (include only these fields)

|    Attribute        |  Description |
|:------------------------------:|:------------:|
| `_clone_fields` | Restrict the list of fields to copy from the instance (By default: Copies all fields excluding auto-created/non editable model fields) |
| `_clone_m2m_fields` | Restricted Many to many fields (i.e Test.tags) |
| `_clone_m2o_or_o2m_fields` | Restricted Many to One/One to Many fields |
| `_clone_o2o_fields` | Restricted One to One fields |
| `_clone_linked_m2m_fields` | Restricted Many to Many fields that should be linked to the new instance |

#### Implicit (include all except these fields)

|  Attribute  | Description |
|:--------------------:|:-----------:|
| `_clone_excluded_fields` | Excluded model fields. |
`_clone_excluded_m2m_fields` | Excluded many to many fields. |
`_clone_excluded_m2o_or_o2m_fields` |  Excluded Many to One/One to Many fields. |
`_clone_excluded_o2o_fields` | Excluded one to one fields. |

> **NOTE:** :warning:
>
> *   Ensure to either set `_clone_excluded_*` or `_clone_*`. Using both would raise errors.

### Django Admin

#### Duplicating Models from the Django Admin view.

![](https://user-images.githubusercontent.com/17484350/221386874-047989a4-ae4d-4d82-9ef6-2b303001a4c2.png)

##### List View

![Screenshot](Duplicate-action.png)

##### Change View

![Screenshot](Duplicate-button.png)

#### CloneModelAdmin class attributes

![](https://user-images.githubusercontent.com/17484350/221387085-e0ca31ee-8c4c-40d9-9ce6-44ff5e6814ff.png)

> **NOTE:** :warning:
>
> *   Ensure that `model_clone` is placed before `django.contrib.admin`

```python
INSTALLED_APPS = [
    'model_clone',
    'django.contrib.admin',
    '...',
]
```

## Advanced Usage

### Signals

#### pre\_clone\_save, post\_clone\_save

![](https://user-images.githubusercontent.com/17484350/221387120-b5219cdb-9f74-4751-b593-2c68db9fd0e0.png)

### Clone Many to Many fields

#### Using the `CloneModel`

![](https://user-images.githubusercontent.com/17484350/221387226-572cedbe-e30e-456d-af75-bcd25edec754.png)

#### Using the `CloneMixin`

![carbon (37)](https://user-images.githubusercontent.com/17484350/221387393-196bcb4b-e136-4d5b-89cd-0fb28d8e6e6e.png)

![](https://user-images.githubusercontent.com/17484350/221387265-ccf05239-ec0c-47ec-b0ed-6c2e01428aee.png)

### Multi database support

![](https://user-images.githubusercontent.com/17484350/221385217-3a123080-b247-4ef0-b876-e75db1518c92.png)

## Compatibility

|  Python      |  Supported version |
|--------------|--------------------|
|  Python2.x  |    `<=2.5.3`       |
|  Python3.5  |    `<=2.9.6`       |
|  Python3.6+  |    All versions    |

|  Django      |   Supported version |
|--------------|---------------------|
|  1.11        |    `<=2.7.2`        |
|  2.x         |    All versions     |
|  3.x         |    All versions     |

## Running locally

```shell
$ git clone git@github.com:tj-django/django-clone.git
$ make default-user
$ make run
```

Spins up a django server running the demo app.

Visit http://127.0.0.1:8000

## Found a Bug?

To file a bug or submit a patch, please head over to [django-clone on github](https://github.com/tj-django/django-clone/issues).

If you feel generous and want to show some extra appreciation:

Support me with a :star:

[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]

[buymeacoffee]: https://www.buymeacoffee.com/jackton1

[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png

## Contributors ✨

Thanks goes to these wonderful people:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

<!-- prettier-ignore-start -->

<!-- markdownlint-disable -->

<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="http://gerritneven.nl"><img src="https://avatars1.githubusercontent.com/u/2500973?v=4?s=100" width="100px;" alt="Gerben Neven"/><br /><sub><b>Gerben Neven</b></sub></a><br /><a href="https://github.com/tj-django/django-clone/issues?q=author%3Agerbyzation" title="Bug reports">πŸ›</a> <a href="https://github.com/tj-django/django-clone/commits?author=gerbyzation" title="Tests">⚠️</a> <a href="https://github.com/tj-django/django-clone/commits?author=gerbyzation" title="Code">πŸ’»</a></td>
      <td align="center" valign="top" width="14.28%"><a href="http://sebastian-kindt.com"><img src="https://avatars1.githubusercontent.com/u/2536081?v=4?s=100" width="100px;" alt="Sebastian Kapunkt"/><br /><sub><b>Sebastian Kapunkt</b></sub></a><br /><a href="https://github.com/tj-django/django-clone/commits?author=SebastianKapunkt" title="Code">πŸ’»</a> <a href="https://github.com/tj-django/django-clone/issues?q=author%3ASebastianKapunkt" title="Bug reports">πŸ›</a> <a href="https://github.com/tj-django/django-clone/commits?author=SebastianKapunkt" title="Tests">⚠️</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/andresp99999"><img src="https://avatars0.githubusercontent.com/u/1036725?v=4?s=100" width="100px;" alt="AndrΓ©s Portillo"/><br /><sub><b>AndrΓ©s Portillo</b></sub></a><br /><a href="https://github.com/tj-django/django-clone/issues?q=author%3Aandresp99999" title="Bug reports">πŸ›</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://renovate.whitesourcesoftware.com"><img src="https://avatars0.githubusercontent.com/u/25180681?v=4?s=100" width="100px;" alt="WhiteSource Renovate"/><br /><sub><b>WhiteSource Renovate</b></sub></a><br /><a href="#maintenance-renovate-bot" title="Maintenance">🚧</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/yuekui"><img src="https://avatars2.githubusercontent.com/u/2561450?v=4?s=100" width="100px;" alt="Yuekui"/><br /><sub><b>Yuekui</b></sub></a><br /><a href="https://github.com/tj-django/django-clone/commits?author=yuekui" title="Code">πŸ’»</a> <a href="https://github.com/tj-django/django-clone/issues?q=author%3Ayuekui" title="Bug reports">πŸ›</a> <a href="https://github.com/tj-django/django-clone/commits?author=yuekui" title="Tests">⚠️</a> <a href="https://github.com/tj-django/django-clone/commits?author=yuekui" title="Documentation">πŸ“–</a> <a href="#maintenance-yuekui" title="Maintenance">🚧</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/diesieben07"><img src="https://avatars.githubusercontent.com/u/1915984?v=4?s=100" width="100px;" alt="Take Weiland"/><br /><sub><b>Take Weiland</b></sub></a><br /><a href="https://github.com/tj-django/django-clone/commits?author=diesieben07" title="Tests">⚠️</a> <a href="https://github.com/tj-django/django-clone/issues?q=author%3Adiesieben07" title="Bug reports">πŸ›</a> <a href="https://github.com/tj-django/django-clone/commits?author=diesieben07" title="Code">πŸ’»</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ptrck"><img src="https://avatars.githubusercontent.com/u/1259703?v=4?s=100" width="100px;" alt="Patrick"/><br /><sub><b>Patrick</b></sub></a><br /><a href="https://github.com/tj-django/django-clone/issues?q=author%3Aptrck" title="Bug reports">πŸ›</a> <a href="https://github.com/tj-django/django-clone/commits?author=ptrck" title="Code">πŸ’»</a></td>
    </tr>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Akollek"><img src="https://avatars.githubusercontent.com/u/5873158?v=4?s=100" width="100px;" alt="Amiel Kollek"/><br /><sub><b>Amiel Kollek</b></sub></a><br /><a href="https://github.com/tj-django/django-clone/commits?author=Akollek" title="Code">πŸ’»</a> <a href="https://github.com/tj-django/django-clone/issues?q=author%3AAkollek" title="Bug reports">πŸ›</a> <a href="https://github.com/tj-django/django-clone/commits?author=Akollek" title="Tests">⚠️</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://erictheise.com/"><img src="https://avatars.githubusercontent.com/u/317680?v=4?s=100" width="100px;" alt="Eric Theise"/><br /><sub><b>Eric Theise</b></sub></a><br /><a href="https://github.com/tj-django/django-clone/commits?author=erictheise" title="Documentation">πŸ“–</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/DanielSchaffer"><img src="https://avatars.githubusercontent.com/u/334487?v=4?s=100" width="100px;" alt="Daniel Schaffer"/><br /><sub><b>Daniel Schaffer</b></sub></a><br /><a href="https://github.com/tj-django/django-clone/commits?author=DanielSchaffer" title="Code">πŸ’»</a> <a href="https://github.com/tj-django/django-clone/commits?author=DanielSchaffer" title="Tests">⚠️</a></td>
    </tr>
  </tbody>
</table>

<!-- markdownlint-restore -->

<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/tj-django/django-clone.git",
    "name": "django-clone",
    "maintainer": "Tonye Jack",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "jtonye@ymail.com",
    "keywords": "django,django-clone,django clone,django object clone,clone-django,model cloning,django instance duplication,django duplication",
    "author": "Tonye Jack",
    "author_email": "jtonye@ymail.com",
    "download_url": "https://files.pythonhosted.org/packages/3c/6c/4b9388069099401f2b9086707e583a8e09acda40e4bc330fd21cb41ecf42/django-clone-5.3.3.tar.gz",
    "platform": null,
    "description": "<p align=\"center\"> \n    <img width=\"466\" alt=\"4FC889E9-FF59-4E44-9EB6-2AF7DC034C74\" src=\"https://user-images.githubusercontent.com/17484350/215616634-17439a58-7bd8-4e9c-989f-e6bef7c73e48.png\">\n</p>\n\n|  Python   | Django  |  Downloads  |   Code Style   |\n|:---------:|:-------:|:-----------:|:--------------:|\n| [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django_clone.svg)](https://pypi.org/project/django-clone) | [![PyPI - Django Version](https://img.shields.io/pypi/djversions/django_clone.svg)](https://docs.djangoproject.com/en/dev/releases/) | [![Downloads](https://pepy.tech/badge/django-clone)](https://pepy.tech/project/django-clone) | [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) |\n\n|    PyPI         | Test | Vulnerabilities | Coverage | Code Quality  |  Pre-Commit   |\n|:---------------:|:----:|:---------------:|:--------:|:-------------:|:-------------:|\n| [![PyPI version](https://badge.fury.io/py/django-clone.svg)](https://badge.fury.io/py/django-clone) | [![Test](https://github.com/tj-django/django-clone/workflows/Test/badge.svg)](https://github.com/tj-django/django-clone/actions?query=workflow%3ATest) | [![Known Vulnerabilities](https://snyk.io/test/github/tj-django/django-clone/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/tj-django/django-clone?targetFile=requirements.txt) | [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/b33dd02dbb034d7fa9886a99f5383ea6)](https://www.codacy.com/gh/tj-django/django-clone?utm_source=github.com\\&utm_medium=referral\\&utm_content=tj-django/django-clone\\&utm_campaign=Badge_Coverage) <br/> [![codecov](https://codecov.io/gh/tj-django/django-clone/branch/main/graph/badge.svg?token=2NE21Oe50Q)](https://codecov.io/gh/tj-django/django-clone)| [![Codacy Badge](https://app.codacy.com/project/badge/Grade/b33dd02dbb034d7fa9886a99f5383ea6)](https://www.codacy.com/gh/tj-django/django-clone?utm_source=github.com\\&utm_medium=referral\\&utm_content=tj-django/django-clone\\&utm_campaign=Badge_Grade) |  [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/tj-django/django-clone/main.svg)](https://results.pre-commit.ci/latest/github/tj-django/django-clone/main) |\n\n## django-clone\n\nCreate copies of a model instance with explicit control on how the instance should be duplicated (limiting fields or related objects copied) with unique field detection.\n\nThis solves the problem introduced by using `instance.pk = None` and `instance.save()` which results in copying more object state than required.\n\n## Features\n\n*   100% test coverage.\n*   More control over how a model instance should be duplicated\n*   Multi Database support i.e Create duplicates on one or more databases.\n*   Restrict fields used for creating a duplicate instance.\n*   Detects unique fields and naively adds a suffix `copy {count}` to each duplicate instance (for supported fields only).\n*   Optionally differentiate between a duplicate instance and the original by appending a **copy** suffix to non unique fields (for supported fields only).\n\n## Table of Contents\n\n*   [Installation](#installation)\n    *   [pip](#pip)\n    *   [poetry](#poetry)\n*   [Usage](#usage)\n    *   [Subclassing the `CloneModel`](#subclassing-the-clonemodel)\n    *   [Using the `CloneMixin`](#using-the-clonemixin)\n    *   [Duplicating a model instance](#duplicating-a-model-instance)\n    *   [Bulk cloning a model](#bulk-cloning-a-model)\n    *   [Creating clones without subclassing `CloneMixin`.](#creating-clones-without-subclassing-clonemixin)\n    *   [CloneMixin attributes](#clonemixin-attributes)\n        *   [Explicit (include only these fields)](#explicit-include-only-these-fields)\n        *   [Implicit (include all except these fields)](#implicit-include-all-except-these-fields)\n    *   [Django Admin](#django-admin)\n        *   [Duplicating Models from the Django Admin view.](#duplicating-models-from-the-django-admin-view)\n            *   [List View](#list-view)\n            *   [Change View](#change-view)\n        *   [CloneModelAdmin class attributes](#clonemodeladmin-class-attributes)\n*   [Advanced Usage](#advanced-usage)\n    *   [Signals](#signals)\n        *   [pre\\_clone\\_save, post\\_clone\\_save](#pre_clone_save-post_clone_save)\n    *   [Clone Many to Many fields](#clone-many-to-many-fields)\n        *   [Using the `CloneModel`](#using-the-clonemodel)\n        *   [Using the `CloneMixin`](#using-the-clonemixin-1)\n    *   [Multi database support](#multi-database-support)\n*   [Compatibility](#compatibility)\n*   [Running locally](#running-locally)\n*   [Found a Bug?](#found-a-bug)\n*   [Contributors \u2728](#contributors-)\n\n## Installation\n\n### pip\n\n```bash\npip install django-clone\n```\n\n### poetry\n\n```bash\npoetry add django-clone\n```\n\n## Usage\n\n### Subclassing the `CloneModel`\n\n![](https://user-images.githubusercontent.com/17484350/221387430-efd5508a-2597-4320-9750-5a4c56833edb.png)\n\n### Using the `CloneMixin`\n\n![](https://user-images.githubusercontent.com/17484350/221387397-6ad5475b-6887-4a5f-b6d3-42784f9dfa7c.png)\n\n### Duplicating a model instance\n\n![](https://user-images.githubusercontent.com/17484350/221386600-731a6f45-1704-4834-bcbe-0f57d912faf7.png)\n\n### Bulk cloning a model\n\n![](https://user-images.githubusercontent.com/17484350/221386555-13978280-35a1-4941-8186-a1c6723a0346.png)\n\n### Creating clones without subclassing `CloneMixin`.\n\n> **NOTE:** :warning:\n>\n> *   This method won't copy over related objects like Many to Many/One to Many relationships.\n> *   Ensure that required fields skipped from being cloned are passed in using the `attrs` kwargs.\n\n![](https://user-images.githubusercontent.com/17484350/221385171-add1a0c3-21fc-4c48-bfe9-4f2014ffe035.png)\n\n### CloneMixin attributes\n\n|    Attribute        |  Description |\n|:------------------------------:|:------------:|\n| `DUPLICATE_SUFFIX` | Suffix to append to duplicates <br> (NOTE: This requires `USE_DUPLICATE_SUFFIX_FOR_NON_UNIQUE_FIELDS` <br> to be enabled and supports string fields). |\n`USE_DUPLICATE_SUFFIX_FOR_NON_UNIQUE_FIELDS` | Enable appending the `DUPLICATE_SUFFIX` to new cloned instances. |\n`UNIQUE_DUPLICATE_SUFFIX` | Suffix to append to unique fields |\n`USE_UNIQUE_DUPLICATE_SUFFIX` | Enable appending the `UNIQUE_DUPLICATE_SUFFIX` to new cloned instances. |\n`MAX_UNIQUE_DUPLICATE_QUERY_ATTEMPTS` | The max query attempt while generating unique values for a case of unique conflicts. |\n\n#### Explicit (include only these fields)\n\n|    Attribute        |  Description |\n|:------------------------------:|:------------:|\n| `_clone_fields` | Restrict the list of fields to copy from the instance (By default: Copies all fields excluding auto-created/non editable model fields) |\n| `_clone_m2m_fields` | Restricted Many to many fields (i.e Test.tags) |\n| `_clone_m2o_or_o2m_fields` | Restricted Many to One/One to Many fields |\n| `_clone_o2o_fields` | Restricted One to One fields |\n| `_clone_linked_m2m_fields` | Restricted Many to Many fields that should be linked to the new instance |\n\n#### Implicit (include all except these fields)\n\n|  Attribute  | Description |\n|:--------------------:|:-----------:|\n| `_clone_excluded_fields` | Excluded model fields. |\n`_clone_excluded_m2m_fields` | Excluded many to many fields. |\n`_clone_excluded_m2o_or_o2m_fields` |  Excluded Many to One/One to Many fields. |\n`_clone_excluded_o2o_fields` | Excluded one to one fields. |\n\n> **NOTE:** :warning:\n>\n> *   Ensure to either set `_clone_excluded_*` or `_clone_*`. Using both would raise errors.\n\n### Django Admin\n\n#### Duplicating Models from the Django Admin view.\n\n![](https://user-images.githubusercontent.com/17484350/221386874-047989a4-ae4d-4d82-9ef6-2b303001a4c2.png)\n\n##### List View\n\n![Screenshot](Duplicate-action.png)\n\n##### Change View\n\n![Screenshot](Duplicate-button.png)\n\n#### CloneModelAdmin class attributes\n\n![](https://user-images.githubusercontent.com/17484350/221387085-e0ca31ee-8c4c-40d9-9ce6-44ff5e6814ff.png)\n\n> **NOTE:** :warning:\n>\n> *   Ensure that `model_clone` is placed before `django.contrib.admin`\n\n```python\nINSTALLED_APPS = [\n    'model_clone',\n    'django.contrib.admin',\n    '...',\n]\n```\n\n## Advanced Usage\n\n### Signals\n\n#### pre\\_clone\\_save, post\\_clone\\_save\n\n![](https://user-images.githubusercontent.com/17484350/221387120-b5219cdb-9f74-4751-b593-2c68db9fd0e0.png)\n\n### Clone Many to Many fields\n\n#### Using the `CloneModel`\n\n![](https://user-images.githubusercontent.com/17484350/221387226-572cedbe-e30e-456d-af75-bcd25edec754.png)\n\n#### Using the `CloneMixin`\n\n![carbon (37)](https://user-images.githubusercontent.com/17484350/221387393-196bcb4b-e136-4d5b-89cd-0fb28d8e6e6e.png)\n\n![](https://user-images.githubusercontent.com/17484350/221387265-ccf05239-ec0c-47ec-b0ed-6c2e01428aee.png)\n\n### Multi database support\n\n![](https://user-images.githubusercontent.com/17484350/221385217-3a123080-b247-4ef0-b876-e75db1518c92.png)\n\n## Compatibility\n\n|  Python      |  Supported version |\n|--------------|--------------------|\n|  Python2.x  |    `<=2.5.3`       |\n|  Python3.5  |    `<=2.9.6`       |\n|  Python3.6+  |    All versions    |\n\n|  Django      |   Supported version |\n|--------------|---------------------|\n|  1.11        |    `<=2.7.2`        |\n|  2.x         |    All versions     |\n|  3.x         |    All versions     |\n\n## Running locally\n\n```shell\n$ git clone git@github.com:tj-django/django-clone.git\n$ make default-user\n$ make run\n```\n\nSpins up a django server running the demo app.\n\nVisit http://127.0.0.1:8000\n\n## Found a Bug?\n\nTo file a bug or submit a patch, please head over to [django-clone on github](https://github.com/tj-django/django-clone/issues).\n\nIf you feel generous and want to show some extra appreciation:\n\nSupport me with a :star:\n\n[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]\n\n[buymeacoffee]: https://www.buymeacoffee.com/jackton1\n\n[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\n\n## Contributors \u2728\n\nThanks goes to these wonderful people:\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n\n<!-- prettier-ignore-start -->\n\n<!-- markdownlint-disable -->\n\n<table>\n  <tbody>\n    <tr>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://gerritneven.nl\"><img src=\"https://avatars1.githubusercontent.com/u/2500973?v=4?s=100\" width=\"100px;\" alt=\"Gerben Neven\"/><br /><sub><b>Gerben Neven</b></sub></a><br /><a href=\"https://github.com/tj-django/django-clone/issues?q=author%3Agerbyzation\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/tj-django/django-clone/commits?author=gerbyzation\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"https://github.com/tj-django/django-clone/commits?author=gerbyzation\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://sebastian-kindt.com\"><img src=\"https://avatars1.githubusercontent.com/u/2536081?v=4?s=100\" width=\"100px;\" alt=\"Sebastian Kapunkt\"/><br /><sub><b>Sebastian Kapunkt</b></sub></a><br /><a href=\"https://github.com/tj-django/django-clone/commits?author=SebastianKapunkt\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/tj-django/django-clone/issues?q=author%3ASebastianKapunkt\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/tj-django/django-clone/commits?author=SebastianKapunkt\" title=\"Tests\">\u26a0\ufe0f</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/andresp99999\"><img src=\"https://avatars0.githubusercontent.com/u/1036725?v=4?s=100\" width=\"100px;\" alt=\"Andr\u00e9s Portillo\"/><br /><sub><b>Andr\u00e9s Portillo</b></sub></a><br /><a href=\"https://github.com/tj-django/django-clone/issues?q=author%3Aandresp99999\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://renovate.whitesourcesoftware.com\"><img src=\"https://avatars0.githubusercontent.com/u/25180681?v=4?s=100\" width=\"100px;\" alt=\"WhiteSource Renovate\"/><br /><sub><b>WhiteSource Renovate</b></sub></a><br /><a href=\"#maintenance-renovate-bot\" title=\"Maintenance\">\ud83d\udea7</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/yuekui\"><img src=\"https://avatars2.githubusercontent.com/u/2561450?v=4?s=100\" width=\"100px;\" alt=\"Yuekui\"/><br /><sub><b>Yuekui</b></sub></a><br /><a href=\"https://github.com/tj-django/django-clone/commits?author=yuekui\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/tj-django/django-clone/issues?q=author%3Ayuekui\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/tj-django/django-clone/commits?author=yuekui\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"https://github.com/tj-django/django-clone/commits?author=yuekui\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#maintenance-yuekui\" title=\"Maintenance\">\ud83d\udea7</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/diesieben07\"><img src=\"https://avatars.githubusercontent.com/u/1915984?v=4?s=100\" width=\"100px;\" alt=\"Take Weiland\"/><br /><sub><b>Take Weiland</b></sub></a><br /><a href=\"https://github.com/tj-django/django-clone/commits?author=diesieben07\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"https://github.com/tj-django/django-clone/issues?q=author%3Adiesieben07\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/tj-django/django-clone/commits?author=diesieben07\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/ptrck\"><img src=\"https://avatars.githubusercontent.com/u/1259703?v=4?s=100\" width=\"100px;\" alt=\"Patrick\"/><br /><sub><b>Patrick</b></sub></a><br /><a href=\"https://github.com/tj-django/django-clone/issues?q=author%3Aptrck\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/tj-django/django-clone/commits?author=ptrck\" title=\"Code\">\ud83d\udcbb</a></td>\n    </tr>\n    <tr>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/Akollek\"><img src=\"https://avatars.githubusercontent.com/u/5873158?v=4?s=100\" width=\"100px;\" alt=\"Amiel Kollek\"/><br /><sub><b>Amiel Kollek</b></sub></a><br /><a href=\"https://github.com/tj-django/django-clone/commits?author=Akollek\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/tj-django/django-clone/issues?q=author%3AAkollek\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/tj-django/django-clone/commits?author=Akollek\" title=\"Tests\">\u26a0\ufe0f</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://erictheise.com/\"><img src=\"https://avatars.githubusercontent.com/u/317680?v=4?s=100\" width=\"100px;\" alt=\"Eric Theise\"/><br /><sub><b>Eric Theise</b></sub></a><br /><a href=\"https://github.com/tj-django/django-clone/commits?author=erictheise\" title=\"Documentation\">\ud83d\udcd6</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/DanielSchaffer\"><img src=\"https://avatars.githubusercontent.com/u/334487?v=4?s=100\" width=\"100px;\" alt=\"Daniel Schaffer\"/><br /><sub><b>Daniel Schaffer</b></sub></a><br /><a href=\"https://github.com/tj-django/django-clone/commits?author=DanielSchaffer\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/tj-django/django-clone/commits?author=DanielSchaffer\" title=\"Tests\">\u26a0\ufe0f</a></td>\n    </tr>\n  </tbody>\n</table>\n\n<!-- markdownlint-restore -->\n\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n",
    "bugtrack_url": null,
    "license": "MIT/Apache-2.0",
    "summary": "Create a clone of a django model instance.",
    "version": "5.3.3",
    "project_urls": {
        "Homepage": "https://github.com/tj-django/django-clone.git"
    },
    "split_keywords": [
        "django",
        "django-clone",
        "django clone",
        "django object clone",
        "clone-django",
        "model cloning",
        "django instance duplication",
        "django duplication"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2b5e2868bede7b6ed783bf08da3bc062c6c77ebe881b0e46009510a91284a152",
                "md5": "ef0f4f17be09aeb900d4c96473e62fc5",
                "sha256": "ea2e5a770d01c62ecf66d0dd6e8df284e26321245b8abcc6d82d8740765b42d5"
            },
            "downloads": -1,
            "filename": "django_clone-5.3.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ef0f4f17be09aeb900d4c96473e62fc5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 17608,
            "upload_time": "2023-06-12T13:09:20",
            "upload_time_iso_8601": "2023-06-12T13:09:20.874271Z",
            "url": "https://files.pythonhosted.org/packages/2b/5e/2868bede7b6ed783bf08da3bc062c6c77ebe881b0e46009510a91284a152/django_clone-5.3.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3c6c4b9388069099401f2b9086707e583a8e09acda40e4bc330fd21cb41ecf42",
                "md5": "f79ae2c143ce202fd88b8e49baf95da8",
                "sha256": "7521798c6bcdea3168fce79d4857afc1d02e02e8e4d801585ad8a36a19d16cc8"
            },
            "downloads": -1,
            "filename": "django-clone-5.3.3.tar.gz",
            "has_sig": false,
            "md5_digest": "f79ae2c143ce202fd88b8e49baf95da8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 31785,
            "upload_time": "2023-06-12T13:09:22",
            "upload_time_iso_8601": "2023-06-12T13:09:22.732195Z",
            "url": "https://files.pythonhosted.org/packages/3c/6c/4b9388069099401f2b9086707e583a8e09acda40e4bc330fd21cb41ecf42/django-clone-5.3.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-12 13:09:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tj-django",
    "github_project": "django-clone",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "django-clone"
}
        
Elapsed time: 0.20594s