Just another blogging / podcasting package
Project description
=============================
Django Cast
=============================
.. image:: https://badge.fury.io/py/django-cast.svg
:target: https://badge.fury.io/py/django-cast
.. image:: https://travis-ci.org/ephes/django-cast.svg?branch=master
:target: https://travis-ci.org/ephes/django-cast
.. image:: https://codecov.io/gh/ephes/django-cast/branch/master/graph/badge.svg
:target: https://codecov.io/gh/ephes/django-cast
Just another blogging / podcasting package
Daocumentation
-------------
The full documentation is at https://django-cast.readthedocs.io.
Quickstart
----------
Install Django Cast::
pip install django-cast
Add django-cast and some dependencies to your `INSTALLED_APPS`:
.. code-block:: python
INSTALLED_APPS = (
...
'imagekit',
'ckeditor',
'ckeditor_uploader',
'rest_framework',
'rest_framework.authtoken',
'cast.apps.CastConfig',
...
)
Add Django Cast's URL patterns:
.. code-block:: python
from django.urls import path
from rest_framework.documentation import include_docs_urls
from rest_framework.authtoken import views as authtokenviews
urlpatterns = [
...
path('cast/', include('cast.urls', namespace='cast')),
path('api/api-token-auth/', authtokenviews.obtain_auth_token),
path('docs/', include_docs_urls(title='API service')),
...
]
The api token auth urls and the docs urls are both necessary to provide api endpoints
with the right namespace.
Add required settings:
.. code-block:: python
# CKEditor
CKEDITOR_UPLOAD_PATH = 'uploads/ckeditor/'
CKEDITOR_IMAGE_BACKEND = 'pillow'
AWS_QUERYSTRING_AUTH = False
X_FRAME_OPTIONS = 'SAMEORIGIN'
CKEDITOR_CONFIGS = {
'default': {
'removePlugins': 'stylesheetparser',
'allowedContent': True,
'enterMode': 2,
},
}
# REST
REST_FRAMEWORK = {
# Use Django's standard django.contrib.auth permissions,
# or allow read-only access for unauthenticated users.
'DEFAULT_AUTHENTICATION_CLASSES': (
'rest_framework.authentication.SessionAuthentication',
'rest_framework.authentication.TokenAuthentication',
)
}
# django imagekit
IMAGEKIT_DEFAULT_CACHEFILE_STRATEGY='imagekit.cachefiles.strategies.Optimistic'
Features
--------
* TODO
Running Tests
-------------
Does the code actually work?
::
source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox
Credits
-------
Tools used in rendering this package:
* Cookiecutter_
* `cookiecutter-djangopackage`_
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
History
0.1.3 (2018-11-17)
++++++++++++++++++
* Fixed css/static icons
* Merged pull request from SmartC2016 to fix javascript block issue
* Added some documentation
0.1.2 (2018-11-08)
++++++++++++++++++
* Added some requirements
* Release Documentation
0.1.1 (2018-11-07)
++++++++++++++++++
* Travis build is ok.
0.1.0 (2018-11-05)
++++++++++++++++++
* First release on PyPI.
Django Cast
=============================
.. image:: https://badge.fury.io/py/django-cast.svg
:target: https://badge.fury.io/py/django-cast
.. image:: https://travis-ci.org/ephes/django-cast.svg?branch=master
:target: https://travis-ci.org/ephes/django-cast
.. image:: https://codecov.io/gh/ephes/django-cast/branch/master/graph/badge.svg
:target: https://codecov.io/gh/ephes/django-cast
Just another blogging / podcasting package
Daocumentation
-------------
The full documentation is at https://django-cast.readthedocs.io.
Quickstart
----------
Install Django Cast::
pip install django-cast
Add django-cast and some dependencies to your `INSTALLED_APPS`:
.. code-block:: python
INSTALLED_APPS = (
...
'imagekit',
'ckeditor',
'ckeditor_uploader',
'rest_framework',
'rest_framework.authtoken',
'cast.apps.CastConfig',
...
)
Add Django Cast's URL patterns:
.. code-block:: python
from django.urls import path
from rest_framework.documentation import include_docs_urls
from rest_framework.authtoken import views as authtokenviews
urlpatterns = [
...
path('cast/', include('cast.urls', namespace='cast')),
path('api/api-token-auth/', authtokenviews.obtain_auth_token),
path('docs/', include_docs_urls(title='API service')),
...
]
The api token auth urls and the docs urls are both necessary to provide api endpoints
with the right namespace.
Add required settings:
.. code-block:: python
# CKEditor
CKEDITOR_UPLOAD_PATH = 'uploads/ckeditor/'
CKEDITOR_IMAGE_BACKEND = 'pillow'
AWS_QUERYSTRING_AUTH = False
X_FRAME_OPTIONS = 'SAMEORIGIN'
CKEDITOR_CONFIGS = {
'default': {
'removePlugins': 'stylesheetparser',
'allowedContent': True,
'enterMode': 2,
},
}
# REST
REST_FRAMEWORK = {
# Use Django's standard django.contrib.auth permissions,
# or allow read-only access for unauthenticated users.
'DEFAULT_AUTHENTICATION_CLASSES': (
'rest_framework.authentication.SessionAuthentication',
'rest_framework.authentication.TokenAuthentication',
)
}
# django imagekit
IMAGEKIT_DEFAULT_CACHEFILE_STRATEGY='imagekit.cachefiles.strategies.Optimistic'
Features
--------
* TODO
Running Tests
-------------
Does the code actually work?
::
source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox
Credits
-------
Tools used in rendering this package:
* Cookiecutter_
* `cookiecutter-djangopackage`_
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
History
0.1.3 (2018-11-17)
++++++++++++++++++
* Fixed css/static icons
* Merged pull request from SmartC2016 to fix javascript block issue
* Added some documentation
0.1.2 (2018-11-08)
++++++++++++++++++
* Added some requirements
* Release Documentation
0.1.1 (2018-11-07)
++++++++++++++++++
* Travis build is ok.
0.1.0 (2018-11-05)
++++++++++++++++++
* First release on PyPI.
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
django-cast-0.1.3.tar.gz
(33.6 kB
view hashes)
Built Distribution
Close
Hashes for django_cast-0.1.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a3bda8b3b781962c13c71ba272c820c736d63bc68acb3ad017b5c221f2b0156 |
|
MD5 | 184886de91c05558e230af7312d39bbd |
|
BLAKE2b-256 | 48fb4e82574b7c7c9f40d02196a22b61b5f7429c2f5ff92390a0629aeb84c1a0 |