Skip to content

README.md

Latest commit

 

History

History
65 lines (46 loc) · 2 KB

README.md

File metadata and controls

65 lines (46 loc) · 2 KB
Raw

DRF Generic Contact

PyPI version Run linter and tests Codecov

An extension of the django-generic-contact that provides a POST endpoint to create new instances for the Contact model via HTTP.

Installation

pip install drf-generic-contact

Make sure the main module django-generic-contact is part of the INSTALLED_APPS.

Usage

Add the ContactViewSet to your project's urls.py, e.g.:

from drf_generic_contact.rest.views import ContactViewSet

router = get_api_router()
router.register(r"contact", ContactViewSet)

urlpatterns = [
    ...
    path("", include(router.urls)),
]

See tests/testapp for exemplary usage.

Unit Tests

See folder tests/. The provided tests cover these criteria:

  • success:
    • add new contact via HTTP POST request
  • failure:
    • HTTP GET request to read contact list
    • HTTP GET request to read single contact
    • HTTP PUT request to update contact
    • HTTP PATCH request to update contact

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.

# install dependencies
python -m pip install --upgrade pip
pip install -e ".[test]"

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

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

See LICENSE for more information.