Skip to content

Commit

Permalink
move to 'anexia' organization
Browse files Browse the repository at this point in the history
  • Loading branch information
anx-abruckner committed Oct 21, 2022
1 parent 7f1748b commit 7905d2e
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 6 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

[Unreleased]: https://github.com/anexia-it/drf-attachments/compare/1.0.0...HEAD
[1.0.0]: https://github.com/anexia-it/drf-attachments/releases/tag/1.0.0
[Unreleased]: https://github.com/anexia/drf-attachments/compare/1.0.0...HEAD
[1.0.0]: https://github.com/anexia/drf-attachments/releases/tag/1.0.0
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If used with DRF, `django-filter` is an additional requirement.
1. Install using pip:

```shell
pip install git+https://github.com/anexia-it/drf-attachments@main
pip install git+https://github.com/anexia/drf-attachments@main
```

2. Integrate `drf_attachments` and `django_userforeignkey` into your `settings.py`
Expand Down Expand Up @@ -284,6 +284,26 @@ python manage.py runserver
# Admin Panel: http://localhost:8000/admin
```

## Unit Tests

See folder [tests/](tests/). Basically, all endpoints are covered with multiple
unit tests.

Follow below instructions to run the tests.
You may exchange the installed Django and DRF versions according to your requirements.
:warning: Depending on your local environment settings you might need to explicitly call `python3` instead of `python`.
```bash
# install dependencies
python -m pip install --upgrade pip
pip install -r requirements.txt

# setup environment
pip install -e .

# run tests
cd tests && python manage.py test
```

## ToDos

* Simplify configuration (maybe a default configuration class that can be subclasses for customizations?)
Expand Down
4 changes: 3 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@
# Development dependencies

# TestApp dependencies

django>=3.2,<4
djangorestframework>=3.13,<4
python-magic>=0.4.18
rest-framework-generic-relations>=2.0.0
django-userforeignkey>=0.4
django-filter>=21.1,<22

# fix importlib version to avoid "AttributeError: 'EntryPoints' object has no attribute 'get'" with flake8
importlib-metadata<5.0
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
description='A django module to manage any model\'s file up-/downloads by relating an Attachment model to it.',
long_description=README,
long_description_content_type='text/markdown',
url='https://github.com/anexia-it/drf-attachments',
url='https://github.com/anexia/drf-attachments',
author='Alexandra Bruckner',
author_email='[email protected]',
install_requires=[
Expand Down
2 changes: 1 addition & 1 deletion tests/core/settings.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
Django settings for "tests" project which assures the functionality of the "drf-attachments" package
(https://github.com/anexia-it/drf-attachments).
(https://github.com/anexia/drf-attachments).
"""

import os
Expand Down

0 comments on commit 7905d2e

Please sign in to comment.