A Django plugin that provides basic views for response handling and template rendering.
Project description
Swing Hello
Django Swing Collection
Introduction
Swing Hello is a simple reusable Django application that provides basic views to demonstrate response handling and template rendering. It is designed to provide simple, yet effective functionality for greeting users through various forms and views. This package includes both function-based and class-based views for returning plain text and rendering templates with context. It showcases the best practices in Django app development, including internationalization, testing, and modular design.
Features
- Function-based view returning a plain text "Hello!" response.
- Class-based view returning a plain text "Hello!" response.
- Function-based view rendering a template with a context.
- Class-based view rendering a template with a context.
Installation
-
Ensure you have Django installed. If not, you can install it using pip:
pip install django
-
Clone the repository or download the package and include it in your Django project.
Setup
-
Add
swing_helloto your Django project'sINSTALLED_APPSinsettings.py:INSTALLED_APPS = [ ... 'swing_hello', ]
-
Include the
swing_helloURLs in your project'surls.py:from django.urls import path, include urlpatterns = [ ... path('hello/', include('swing_hello.urls')), ]
Usage
Function-Based Views
hello_response_view: Returns a plain text "Hello!" response.hello_template_view: Renders a template with a context.
Class-Based Views
HelloResponseView: Returns a plain text "Hello!" response.HelloTemplateView: Renders a template with a context.
URL Patterns
The package provides the following URL patterns:
/hello/- Renders the template with context usingHelloTemplateView./hello/response- Returns a plain text "Hello!" response usingHelloResponseView./hello/template- Renders the template with context usingHelloTemplateView.
Example Template
The package includes a simple HTML template hello.html:
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>{{ title }}</title>
<style>
body {
font-family: Arial, sans-serif;
line-height: 1.6;
margin: 0;
padding: 0;
display: flex;
justify-content: center;
align-items: center;
height: 100vh;
background-color: #f4f4f4;
}
.container {
background: #fff;
padding: 20px;
border-radius: 8px;
box-shadow: 0 0 10px rgba(0, 0, 0, 0.1);
text-align: center;
}
h1 {
margin-bottom: 20px;
color: #333;
}
p {
color: #666;
}
</style>
</head>
<body>
<div class="container">
<h1>{{ title }}</h1>
<p>{{ content }}</p>
</div>
</body>
</html>
Project Structure
swing_hello/
├── demo/ # This directory contains a sample Django project for testing your reusable app (swing_hello).
│ ├── manage.py # Entry point for managing the demo project.
│ ├── demo/
│ │ ├── __init__.py
│ │ ├── settings.py # Configuration for the demo project.
│ │ ├── urls.py # Main URL configuration for testing.
│ │ └── wsgi.py
│ └── db.sqlite3
├── src/
│ ├── swing_hello/ # Core directory of your reusable Django app.
│ ├── __init__.py # Initializes the Python module.
│ ├── __main__.py
│ ├── apps.py # Defines the app configuration for Django.
│ ├── urls.py # URLs specific to this app.
│ ├── forms/ # Contains Django forms (e.g., form_hello.py).
│ │ ├── __init__.py
│ │ └── form_hello.py
│ ├── locale/ # Holds translation files for internationalization (e.g., en, nl).
│ │ ├── en/
│ │ │ └── ...
│ │ └── nl/
│ │ └── ...
│ ├── migrations/ # Contains migration scripts for the app.
│ │ ├── __init__.py
│ │ └── ...
│ ├── static/ # Stores app-specific static files (e.g., styles.css).
│ │ └── swing_hello/
│ │ └── styles.css
│ ├── templates/ # App-specific templates (e.g., hello_template.html).
│ │ └── swing_hello/
│ │ ├── hello_form.html
│ │ └── hello_template.html
│ ├── tests/ # Test cases for the app (e.g., test_hello_form.py).
│ │ ├── __init__.py
│ │ ├── test_hello_form.py
│ │ ├── test_hello_json.py
│ │ ├── test_hello_response.py
│ │ ├── test_hello_template.py
│ │ └── ...
│ └── views/ # App views organized by functionality (e.g., view_hello_form.py).
│ ├── __init__.py
│ ├── view_hello_form.py
│ ├── view_hello_json.py
│ ├── view_hello_response.py
│ ├── view_hello_template.py
│ └── ...
├── setup.py # Configuration for packaging and distributing the app.
├── README.md # Documentation for the repository.
└── LICENSE # Specifies the license for the project.
Colophon
Made with ❤️ by Scape Agency
Contributing
Contributions are welcome! Please fork the repository and submit a pull request with your changes.
License
This project is licensed under the BSD-3-Clause license. See the LICENSE file for details.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file swing_hello-0.2.1.tar.gz.
File metadata
- Download URL: swing_hello-0.2.1.tar.gz
- Upload date:
- Size: 1.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1b1d0387e2eb7f70664dde515e006f4fea49b6dd46d3550dcff14d720c8b01f6
|
|
| MD5 |
20d4acd5062d20a550d7bcb102e50019
|
|
| BLAKE2b-256 |
1451cda36b5d6b7b225512c1fde2e50b5bc3c04fef41fb0dc4ead1580def3ead
|
File details
Details for the file swing_hello-0.2.1-py3-none-any.whl.
File metadata
- Download URL: swing_hello-0.2.1-py3-none-any.whl
- Upload date:
- Size: 23.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d721ee2f35c949cb2098e5711692129bcf292c25181bfb2f3667b41895777255
|
|
| MD5 |
e4306038b433595521ecf443a95161e6
|
|
| BLAKE2b-256 |
2071beb2d3ccf0ea81a183eb5432e9fa486621f8e5696bf7a4ed653fb3de7bfa
|
