'A set of django rest apis to manage your calendar'
Project description
Landelayo
Introduction
Landelayo is a set of Django REST API's to manage your calendars, events and their occurrences.
This project was inspired by django-scheduler project but with a narrower focus and a REST API.
Install And Setup
pip install django-landelayo
Landelayo uses the DefaultRouter
provided by the django rest-framework.
To incorporate it into your projects urls.py
file with your other apis, you can do the following
from django.urls import include, path
from rest_framework.routers import DefaultRouter
from landelayo.urls import router as landelayo_router
# Your Main Project Router
router = DefaultRouter()
router.registry.extend(landelayo_router.registry)
urlpatterns = [
path('api/v1/', include(router.urls)),
...
]
Settings
A Configuration variable called LANDELAYO_USER_SERIALIZER
is available to use your own user serializer.
The default is landelayo.settings.UserSerializer
ViewSets
There are 3 Api's that are provided.
-
Calendar
- Eg:
http://localhost:8000/api/v1/calendars
- Grouping events.
- Allows for the creating and editing of different calendar names.
- More Documentation and Screenshots Here
- Eg:
-
Events
- Eg:
http://localhost:8000/api/v1/events
- This allows for the creation and editing of events.
- This also allows for setting the rules for event occurrences.
- More Documentation and Screenshots Here
- Eg:
-
Upcoming
- Eg:
http://localhost:8000/api/v1/upcoming
- View event occurrences over a particular date period (DAY, WEEK, MONTH)
- The is also an option to view over a custom period (CUSTOM)
- More Documentation and Screenshots Here
- Eg:
OpenAPI
Landelayo has support for swagger docs
Project details
Release history Release notifications | RSS feed
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
Hashes for django_landelayo-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40458307754bc0570397e6c2a9dfe1ba4364d057fe62d49376173ca50fea6cfc |
|
MD5 | a6c2d6595d2edd5d27009f4b6a02c712 |
|
BLAKE2b-256 | 50ca23fad93a3d232b4626a6a1c5b8ab96c23fadb8adb6e754052fc8fe8af239 |