Metadata-Version: 2.1
Name: django-admin-anchors
Version: 1.0.1
Summary: Link related objects in Django admin using decorators
Home-page: https://github.com/DoctorJohn/django-admin-anchors
Author: Jonathan Ehwald
Author-email: pypi@ehwald.info
License: MIT License
Description: # Django Admin Anchors
        
        [![PyPI](https://img.shields.io/pypi/v/django-admin-anchors)](https://pypi.org/project/django-admin-anchors/)
        [![PyPI - License](https://img.shields.io/pypi/l/django-admin-anchors)](https://github.com/DoctorJohn/django-admin-anchors/blob/master/LICENSE)
        
        Turn Django admin list display items into clickable links to related objects using
        decorators.
        
        ## Installation
        
        `pip install django-admin-anchors`
        
        ## Usage
        
        ```python
        # yourapp/admin.py
        from django.contrib import admin
        from admin_anchors.decorators import admin_anchor
        from yourapp.models import Player
        
        
        @admin.register(Player)
        class PlayerAdmin(admin.ModelAdmin):
            list_display = ["__str__", "profile_link", "teams_link"]
        
            @admin_anchor(field_name="profile")
            def profile_link(self, instance):
                return "Profile"
        
            @admin_anchor(field_name="teams")
            def teams_link(self, instance):
                return f"{instance.teams.count()} teams"
        ```
        
        Take a look at the `tests/project` directory to see a runnable example project.
        
        ## Contributing
        
        ### Setup
        
        1. Clone the repository and enter the cloned folder
        2. (optional) Create and activate a dedicated Python virtual environment
        3. Run `pip install -e ".[dev]"` to install the projects requirements
        4. (optional) Run `pre-commit install` to install the pre-commit hook
        
        ### Pre-commit hook
        
        Our pre-commit hook formats and lints the code.
        
        ### Formatting and linting
        
        - Run `black admin_anchors tests` to format the code
        - Run `flake8 admin_anchors tests` to lint the code
        
        ### Testing
        
        - Run `py.test --cov admin_anchors tests` to run the tests in the current Python env
        - Run `tox` to run the tests in all supported Python and Django environments
        
        ### Makefile
        
        All commands listed above have shortcut make recipes.
        Take a look at the `Makefile` to learn more.
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Django :: 3.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
