wagtail-modeladmin


Namewagtail-modeladmin JSON
Version 2.0.0 PyPI version JSON
download
home_page
SummaryAdd any model in your project to the Wagtail admin. Formerly wagtail.contrib.modeladmin.
upload_time2024-02-05 17:19:31
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # Wagtail ModelAdmin

[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![PyPI version](https://badge.fury.io/py/wagtail-modeladmin.svg)](https://badge.fury.io/py/wagtail-modeladmin)
[![ModelAdmin CI](https://github.com/wagtail-nest/wagtail-modeladmin/actions/workflows/test.yml/badge.svg)](https://github.com/wagtail-nest/wagtail-modeladmin/actions/workflows/test.yml)

Add any model in your project to the Wagtail admin. Formerly `wagtail.contrib.modeladmin`.

This package is in maintenance mode and will not receive new features. Consider [migrating to Snippets](https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/migrating_to_snippets.html) and opening new feature requests in the [Wagtail issue tracker](https://github.com/wagtail/wagtail/issues).

## Links

- [Documentation](https://wagtail-modeladmin.readthedocs.io)
- [Changelog](https://github.com/wagtail-nest/wagtail-modeladmin/blob/main/CHANGELOG.md)
- [Contributing](https://github.com/wagtail-nest/wagtail-modeladmin/blob/main/CHANGELOG.md)
- [Discussions](https://github.com/wagtail-nest/wagtail-modeladmin/discussions)
- [Security](https://github.com/wagtail-nest/wagtail-modeladmin/security)

## Supported versions

- Python 3.8, 3.9, 3.10, 3.11, 3.12
- Django 4.2, 5.0
- Wagtail 5.2, 6.0

## Installation

- `python -m pip install wagtail-modeladmin`
- Add `wagtail_modeladmin` to your `INSTALLED_APPS` setting.
  ```python
  INSTALLED_APPS = [
      # ...
      "wagtail_modeladmin",
      # ...
  ]
  ```

## Contributing

### Install

To make changes to this project, first clone this repository:

```sh
git clone https://github.com/wagtail-nest/wagtail-modeladmin.git
cd wagtail-modeladmin
```

With your preferred virtualenv activated, install testing dependencies:

#### Using pip

```sh
python -m pip install --upgrade pip>=21.3
python -m pip install -e .[testing] -U
```

#### Using flit

```sh
python -m pip install flit
flit install
```

### pre-commit

Note that this project uses [pre-commit](https://github.com/pre-commit/pre-commit).
It is included in the project testing requirements. To set up locally:

```shell
# go to the project directory
$ cd wagtail-modeladmin
# initialize pre-commit
$ pre-commit install

# Optional, run all checks once for this, then the checks will run only on the changed files
$ git ls-files --others --cached --exclude-standard | xargs pre-commit run --files
```

### How to run tests

Now you can run tests as shown below:

```sh
tox
```

or, you can run them for a specific environment `tox -e python3.10-django4.2-wagtail4.1` or specific test
`tox -e python3.10-django4.2-wagtail4.1-sqlite wagtail-modeladmin.tests.test_file.TestClass.test_method`

To run the test app interactively, use `tox -e interactive`, visit `http://127.0.0.1:8020/admin/` and log in with `admin`/`changeme`.


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "wagtail-modeladmin",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "Wagtail Core Team <hello@wagtail.org>",
    "download_url": "https://files.pythonhosted.org/packages/9d/cf/237bea2abaf8a71b93ea152bb39e62a939453753c3794aaca32b9aac12e6/wagtail_modeladmin-2.0.0.tar.gz",
    "platform": null,
    "description": "# Wagtail ModelAdmin\n\n[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)\n[![PyPI version](https://badge.fury.io/py/wagtail-modeladmin.svg)](https://badge.fury.io/py/wagtail-modeladmin)\n[![ModelAdmin CI](https://github.com/wagtail-nest/wagtail-modeladmin/actions/workflows/test.yml/badge.svg)](https://github.com/wagtail-nest/wagtail-modeladmin/actions/workflows/test.yml)\n\nAdd any model in your project to the Wagtail admin. Formerly `wagtail.contrib.modeladmin`.\n\nThis package is in maintenance mode and will not receive new features. Consider [migrating to Snippets](https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/migrating_to_snippets.html) and opening new feature requests in the [Wagtail issue tracker](https://github.com/wagtail/wagtail/issues).\n\n## Links\n\n- [Documentation](https://wagtail-modeladmin.readthedocs.io)\n- [Changelog](https://github.com/wagtail-nest/wagtail-modeladmin/blob/main/CHANGELOG.md)\n- [Contributing](https://github.com/wagtail-nest/wagtail-modeladmin/blob/main/CHANGELOG.md)\n- [Discussions](https://github.com/wagtail-nest/wagtail-modeladmin/discussions)\n- [Security](https://github.com/wagtail-nest/wagtail-modeladmin/security)\n\n## Supported versions\n\n- Python 3.8, 3.9, 3.10, 3.11, 3.12\n- Django 4.2, 5.0\n- Wagtail 5.2, 6.0\n\n## Installation\n\n- `python -m pip install wagtail-modeladmin`\n- Add `wagtail_modeladmin` to your `INSTALLED_APPS` setting.\n  ```python\n  INSTALLED_APPS = [\n      # ...\n      \"wagtail_modeladmin\",\n      # ...\n  ]\n  ```\n\n## Contributing\n\n### Install\n\nTo make changes to this project, first clone this repository:\n\n```sh\ngit clone https://github.com/wagtail-nest/wagtail-modeladmin.git\ncd wagtail-modeladmin\n```\n\nWith your preferred virtualenv activated, install testing dependencies:\n\n#### Using pip\n\n```sh\npython -m pip install --upgrade pip>=21.3\npython -m pip install -e .[testing] -U\n```\n\n#### Using flit\n\n```sh\npython -m pip install flit\nflit install\n```\n\n### pre-commit\n\nNote that this project uses [pre-commit](https://github.com/pre-commit/pre-commit).\nIt is included in the project testing requirements. To set up locally:\n\n```shell\n# go to the project directory\n$ cd wagtail-modeladmin\n# initialize pre-commit\n$ pre-commit install\n\n# Optional, run all checks once for this, then the checks will run only on the changed files\n$ git ls-files --others --cached --exclude-standard | xargs pre-commit run --files\n```\n\n### How to run tests\n\nNow you can run tests as shown below:\n\n```sh\ntox\n```\n\nor, you can run them for a specific environment `tox -e python3.10-django4.2-wagtail4.1` or specific test\n`tox -e python3.10-django4.2-wagtail4.1-sqlite wagtail-modeladmin.tests.test_file.TestClass.test_method`\n\nTo run the test app interactively, use `tox -e interactive`, visit `http://127.0.0.1:8020/admin/` and log in with `admin`/`changeme`.\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Add any model in your project to the Wagtail admin. Formerly wagtail.contrib.modeladmin.",
    "version": "2.0.0",
    "project_urls": {
        "Home": "https://github.com/wagtail-nest/wagtail-modeladmin"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2723ab5bbdc07732d90410f16f0d20eacba9772467458784a7dfaa7fe1e34c0d",
                "md5": "ddc621e7bbb414da2c1e6f5277954d04",
                "sha256": "36931ce4b2c2bb56d0367317b29786eb001344b7c9a1cd4f719d7f11efeae71b"
            },
            "downloads": -1,
            "filename": "wagtail_modeladmin-2.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ddc621e7bbb414da2c1e6f5277954d04",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 263510,
            "upload_time": "2024-02-05T17:19:29",
            "upload_time_iso_8601": "2024-02-05T17:19:29.233934Z",
            "url": "https://files.pythonhosted.org/packages/27/23/ab5bbdc07732d90410f16f0d20eacba9772467458784a7dfaa7fe1e34c0d/wagtail_modeladmin-2.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9dcf237bea2abaf8a71b93ea152bb39e62a939453753c3794aaca32b9aac12e6",
                "md5": "1a7fc4ed6078570b26b2a71052800592",
                "sha256": "3794c854b86d69ad1b2ec4f3ee5e6852ff8cb0505bd9151186ef26e0a88d84bc"
            },
            "downloads": -1,
            "filename": "wagtail_modeladmin-2.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "1a7fc4ed6078570b26b2a71052800592",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 134939,
            "upload_time": "2024-02-05T17:19:31",
            "upload_time_iso_8601": "2024-02-05T17:19:31.600139Z",
            "url": "https://files.pythonhosted.org/packages/9d/cf/237bea2abaf8a71b93ea152bb39e62a939453753c3794aaca32b9aac12e6/wagtail_modeladmin-2.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-05 17:19:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "wagtail-nest",
    "github_project": "wagtail-modeladmin",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "tox": true,
    "lcname": "wagtail-modeladmin"
}
        
Elapsed time: 0.61081s