MyNewsdesk API的Django包
django-mynewsdesk的Python项目详细描述
安装
使用您喜爱的python安装程序从pypi安装它:
pip install django-mynewsdesk
快速启动
将“MyNewsDesk”添加到已安装的应用程序设置中,如下所示:
INSTALLED_APPS = ( ... 'mynewsdesk', )
将MyNewsDesk密钥添加到如下设置:
MYNEWSDESK_KEY = 'your unique key'
对于South支持,请自定义South_Migration_模块设置,如下所示:
SOUTH_MIGRATION_MODULES = { 'mynewsdesk': 'mynewsdesk.south_migrations', }
运行python manage.py migrate以创建轮询模型。
API
mynewsdesk.api.request(service,params)-请求mynewsdesk api
service: MyNewsDesk API service name params: params for request
return: request response (request library)
mynewsdesk.api.get_list(媒体类型)-请求材料列表
type_of_media: mynewsdesk.models.TYPE_PRESSRELEASE, mynewsdesk.models.TYPE_NEWS, etc…
returns: JSON from api request
mynewsdesk.api.subscribe(电子邮件,类型列表)-订阅电子邮件
email: e-mail of subscriber types_list: list of material types for subscription
mynewsdesk.sync.sync_list(媒体类型)-将材料同步到本地数据库
type_of_media: mynewsdesk.models.TYPE_PRESSRELEASE, mynewsdesk.models.TYPE_NEWS, etc…
returns: dictionary like this {updated: n, create: n, errors: n}
mynewsdesk.sync.sync_all()-将所有类型的材料同步到本地数据库
returns: dictionary like this {updated: n, create: n, errors: n}
贡献和支持
如果您有一个问题请求,或者您发现了一个bug,您可以很容易地在github问题上报告它们。 如果您想修复bug或创建新功能,只需fork,进行更改并创建一个pull请求。你可以在下面找到任务清单。 此外,您还可以创建更好的文档。
待办事项
- “view”api服务的方法
- “搜索”API服务的方法
- “Pressroom_info”API服务的方法
- “创建注释”API服务的方法
- 取消对模型的注释并解析“subjects”
- 取消对模型的注释并分析“地理区域”
- 取消对模型的注释并解析“联系人”
- 取消对模型的注释并分析“注释”
- 分析“相关项”
- 解析“即时消息”