Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matagus/django-generic-links
🗂️ Django application for associating links + metadata to any model instance
https://github.com/matagus/django-generic-links
django django-application django-generic-links django-model links python relationships urls
Last synced: 2 months ago
JSON representation
🗂️ Django application for associating links + metadata to any model instance
- Host: GitHub
- URL: https://github.com/matagus/django-generic-links
- Owner: matagus
- License: other
- Created: 2012-05-20T13:48:20.000Z (over 12 years ago)
- Default Branch: main
- Last Pushed: 2024-03-19T11:44:39.000Z (9 months ago)
- Last Synced: 2024-09-28T16:41:10.597Z (3 months ago)
- Topics: django, django-application, django-generic-links, django-model, links, python, relationships, urls
- Language: Python
- Homepage: https://pypi.org/project/django-generic-links/
- Size: 856 KB
- Stars: 18
- Watchers: 6
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
- Authors: AUTHORS.md
Awesome Lists containing this project
README
django-generic-links
====================
 [](https://pypi.python.org/pypi/django-generic-links)  [](https://codecov.io/gh/matagus/django-generic-links) [](https://opensource.org/licenses/BSD-3-Clause)
 [](https://pypi.python.org/pypi/django-generic-links)  [](https://codecov.io/gh/matagus/django-generic-links) [](https://opensource.org/licenses/BSD-3-Clause)
Simple app to attach links to any Django model. Compatible with Django 4.x to 5.0 and Python 3.9 to 3.12.
Features
========
- Model for creating generic link relations
- Reverse Generic Relation (Django) for your models
- Model Admin
- Generic inline admin to manage any model's generic links
- A template tag to get all links for a given model instance
- A fully working example project
Installation
============
Via `pip` command:
```bash
pip install django-generic-links
```
...or you can clone the repo and install it using `pip` too:
```bash
git clone git://github.com/matagus/django-generic-links.git
cd django-generic-links
pip install -e .
```
then add `generic_links` to your `settings.py`:
```python
INSTALLED_APPS = (
# ...
"generic_links",
)
```
then run the migrations:
```bash
python manage.py migrate
```
and finally add the reverse generic relation to each of the models you're going to add generic links to:
```python
from django.db import models
from django.contrib.contenttypes.fields import GenericRelation
class Artist(models.Model):
name = models.CharField(max_length=100)
bio = models.TextField()
# This is important so that we can get the GenericLink related instances for an object of this model
generic_links = GenericRelation("generic_links.GenericLink")
class Album(models.Model):
title = models.CharField(max_length=100)
artist = models.ForeignKey(Artist, on_delete=models.CASCADE)
release_date = models.DateField(null=True, blank=True)
generic_links = GenericRelation("generic_links.GenericLink")
```
Usage
=====
Using django-generic-links models
---------------------------------
```python
>>> from generic_links.models import GenericLink
>>> from music.models import Artist
>>>
>>> # Get an artist from the database...
>>> lou_reed = Artist.objects.get(pk=1)
>>> lou_reed
>>>
>>> # Create the first link
>>> link1 = GenericLink(title="Wikipedia Page", url="http://en.wikipedia.org/wiki/Lou_Reed", content_object=lou_reed)
>>> link1.save()
>>>
>>> # and then a second one
>>> link2 = GenericLink(title="Encyclopaedia Britannica", url="https://www.britannica.com/biography/Lou-Reed",
content_object=lou_reed)
>>> link2.save()
>>>
>>> # Now get all the links for the artist object:
>>> lou_reed.generic_links.all()
,
]>
```
Generic Links Inline Admin
--------------------------
Since a `GenericLink` instance will be associated to another object you usually
wish to show an inline model admin form in that model form.
```python
from django.contrib import admin
from generic_links.admin import GenericLinkStackedInline
from music_app.models import Artist
@admin.register(Artist)
class ArtistAdmin(admin.ModelAdmin):
# ...
inlines = [GenericLinkStackedInline]
```
Using django-generic-links templatetags
---------------------------------------
Now imagine you have an artist page. You're passing `artist` object using template
context and you want to get all the links for it:
```html
{% load generic_links_tags %}
{{ artist.name }}
{{ artist.description }}
Links for {{ artist.name }}
{% get_links_for artist as artist_links %}
{% for link in artist_links %}
‹li> {{ link. title }}
{% endfor %}
```
Contributing
============
Contributions are welcome! ❤️
Please read [Contributing.md](CONTRIBUTING.md) for detailed instructions on how to help.
Running Tests
-------------
`hatch run test:test` will run the tests in every Python + Django versions combination.
`hatch run test.py3.12-5.0:test will run them for python 3.12 and Django 5.0. Please see possible combinations using
`hatch env show` ("test" matrix).
License
=======
`django-generic-links` is released under an BSD License - see the `LICENSE` file
for more information.
Acknowledgements
================
Develop & built using [](https://github.com/pypa/hatch) [](https://github.com/astral-sh/ruff) [](https://github.com/psf/black)
Tools used in building this package:
- [Cookiecutter](https://github.com/audreyr/cookiecutter) and [cookiecutter-djangopackage](https://github.com/pydanny/cookiecutter-djangopackage) for rendering this package.
Posts I learned from:
- [Switching to Hatch](https://andrich.me/2023/08/switching-to-hatch/)
- [Automate Hatch Publish with GitHub Actions](https://blog.pecar.me/automate-hatch-publish)