Skip to content

Commit

Permalink
Merge pull request #19 from matagus/move-from-setuptools-to-hatch
Browse files Browse the repository at this point in the history
Removed setup.py + updated README to explain how to use hatch instead.
  • Loading branch information
matagus authored Feb 6, 2024
2 parents 133fca7 + 5546a8e commit a9e3951
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 152 deletions.
6 changes: 0 additions & 6 deletions MANIFEST.in

This file was deleted.

14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Installing `django-generic-links` is fairly easy. You can...

git clone git://github.com/matagus/django-generic-links.git
cd django-generic-links
sudo python setup.py install
pip install -e .

then add `generic_links` to your `settings.py`:

Expand All @@ -49,17 +49,17 @@ Usage
Using django-generic-links models
---------------------------------

Imagine you have a music app in your project where you store Artist data. And you
would like to store and display links for each artist, say his facebook page,
his last.fm profile, his youtube artist page and the like:
Imagine you have a music app in your project where you save and manage artist's data. So you have an `Artist model`.
And you'd like to store and display links for each artist, say her facebook page, her youtube artist page and her
last.fm profile page:

![](docs/images/usage.png)


Generic Links Inline Admin
--------------------------

Since a GenericLink instance will be associated to another object you usually
Since a `GenericLink` instance will be associated to another object you usually
wish to show an inline model admin form in that model form.

![](docs/images/inline.png)
Expand Down Expand Up @@ -97,14 +97,14 @@ repo, commit, push and send me a pull request


License
-------
=======

`django-generic-links` is released under an BSD License - see the `LICENSE` file
for more information.


Acknowledgements
----------------
================

Develop & built using [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

Expand Down
25 changes: 0 additions & 25 deletions runtests.py

This file was deleted.

21 changes: 0 additions & 21 deletions setup.cfg

This file was deleted.

78 changes: 0 additions & 78 deletions setup.py

This file was deleted.

15 changes: 0 additions & 15 deletions tox.ini

This file was deleted.

0 comments on commit a9e3951

Please sign in to comment.