AndrewJBateman / python-django-api

:clipboard: Python 3.8 with django used to display info from an API

⚡ Python Django API

• A RESTful API built using Python and the Django framework
• Note: to open web links in a new window use: ctrl+click on link

📄 Table of contents

• ⚡ Python Django API
  • 📄 Table of contents
  • 📚 General info
  • 📷 Screenshots
  • 📶 Technologies
  • 💾 Setup
  • 💻 Code Examples
  • 🆒 Features
  • 📋 Status & To-do list
  • 👏 Inspiration
  • ✉️ Contact

📚 General info

• Django framework: dynamic CRUD interface used, configured with admin models
• Python Models used as the source of information about data
• Django ModelSerialisers REST framework includes both Serializer classes, and ModelSerializer classes.
• Django Generic View classes used to save code.
• Django REST framework Mixin classes used to provide basic view behaviour.
• Django REST framework Authentication token-based HTTP Authentication scheme used
• Django REST framework Viewsets used to allow the URL construction to be handled automatically

📷 Screenshots

📶 Technologies

• Python v3 programming language
• Django v3 web framework
• Django Rest Framework v3 powerful and flexible toolkit for building Web APIs
• Postman test API to send HTTP POST, PUT, GET and DELETE requests

💾 Setup

• Install Python
• Install pip
• Install Django
• Add code
• Enter python manage.py runserver to run server on port 8000

💻 Code Examples

• The ArticleViewSet class with the queryset and serializer_class attributes provided. The actions provided by the ModelViewSet class are .list(), .retrieve(), .create(), .update(), .partial_update(), and .destroy().

class ArticleViewSet(viewsets.ModelViewSet):
    """
    A simple ViewSet for viewing all articles.
    """
    queryset = Article.objects.all()
    serializer_class = ArticleSerializer

🆒 Features

• tba

📋 Status & To-do list

• Status: Mostly complete
• To-do: Add commenting and test some more

👏 Inspiration

• Parwiz Forogh: Django REST Framework Full Course For Beginners | Build REST API With Django
• Parwiz Blog: Django REST Framework Course for Beginners but beware of popups
• Data to Fish: How to Upgrade PIP in Windows
• The Hitchhiker’s Guide to Python!

📁 License

• This project is licensed under the terms of the MIT license.

✉️ Contact

• Repo created by ABateman, email: [e-mail]