{ "info": { "author": "Vinta Software", "author_email": "contact@vinta.com.br", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Framework :: Django", "Framework :: Django :: 1.10", "Framework :: Django :: 1.11", "Framework :: Django :: 1.8", "Framework :: Django :: 1.9", "Framework :: Django :: 2.0", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6" ], "description": "=============================\nDjango Knowledge Share\n=============================\n\n.. image:: https://badge.fury.io/py/django-knowledge-share.svg\n :target: https://badge.fury.io/py/django-knowledge-share\n\n.. image:: https://travis-ci.org/vintasoftware/django-knowledge-share.svg?branch=master\n :target: https://travis-ci.org/vintasoftware/django-knowledge-share\n\n.. image:: https://codecov.io/gh/vintasoftware/django-knowledge-share/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/vintasoftware/django-knowledge-share\n\nMicroblog app used to share quick knowledge. This code powers Vinta's lessons learned\nrunning at http://www.vinta.com.br/lessons-learned/.\n\nThe posts are created via slack using a custom command and are automatically posted on twitter.\n\nQuickstart\n----------\n\nInstall Django Knowledge Share::\n\n pip install django-knowledge-share\n\nCreate an app for your microblog::\n\n python manage.py startapp microblog\n\nAdd it to your `INSTALLED_APPS`:\n\n.. code-block:: python\n\n INSTALLED_APPS = (\n ...\n \"microblog\",\n \"knowledge_share\",\n ...\n )\n\nIn your urls.py add the urls entry::\n\n url(r'^', include('knowledge_share.urls', namespace='microblog')),\n\nIn your microblog/models.py create your models by inheriting from the abstract models:\n\n.. code-block:: python\n\n # customize those models as needed\n from knowledge_share import models as knowledge_share_abstract_models\n\n\n class MicroBlogPost(knowledge_share_abstract_models.MicroBlogPostBase):\n pass\n\n\n class MicroBlogCategory(knowledge_share_abstract_models.MicroBlogCategoryBase):\n pass\n\nThen create and run your migrations::\n\n python manage.py makemigrations\n python manage.py migrate\n\n\nDocumentation\n-------------\n\nModels\n~~~~~~\n\nYou can see the available models and it's fields `here\n`_. They are all abstract and you need to create an instance of it (see Quickstart section).\n\nSlack Integration\n~~~~~~~~~~~~~~~~~\n\nCreate a custom command in this page: `https://my.slack.com/services/new/slash-commands `_.\n\nSet the url to your slack endpoint, by default https://yoursite.com/microblog/integrations/slack-slash/\nCopy the generated token and add to your settings.py as \"SLACK_TOKEN='your-token'\".\nTo send a new post use ``/yourcommand This is a blog post content [Category, Another Category]``\n\nTwitter Integration\n~~~~~~~~~~~~~~~~~~~\n\nYou will need to set the following settings using your twitter data::\n\n TWITTER_API_KEY\n TWITTER_API_SECRET\n TWITTER_ACCESS_TOKEN\n TWITTER_ACCESS_TOKEN_SECRET\n\nWhenever new posts are created it will be posted to twitter.\n\nTemplate tags\n~~~~~~~~~~~~~\n\nWhenever you are showing the content of the post you should use::\n\n {% load microblog %}\n\n {{ post.content|convert_to_html }}\n\nIf you want to create a link with the content to be shared you can use::\n\n {% load microblog %}\n\n \n Share on twitter\n \n\nRSS Feed\n~~~~~~~~\n\nThere is a RSS feed served by default at /microblog/feed/.\n\nConfiguration\n~~~~~~~~~~~~~\n\nThe following configurations are available:\n\n.. code-block:: python\n\n # settings.py\n\n # name of the app created with your microblog's models\n KNOWLEDGE_APP_NAME = 'microblog'\n # the title of the rss feed (available at: /microblog/feed/)\n KNOWLEDGE_FEED_TITLE = 'microblog'\n # the link of the feed\n KNOWLEDGE_FEED_LINK = '/microblog/'\n # Either to use twitter or not\n KNOWLEDGE_USE_TWITTER = True\n\n\nRunning Tests\n-------------\n\n::\n\n source /bin/activate\n (myenv) $ pip install tox\n (myenv) $ tox\n\nCredits\n-------\n\nTools used in rendering this package:\n\n* Cookiecutter_\n* `cookiecutter-djangopackage`_\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/vintasoftware/django-knowledge-share", "keywords": "django-knowledge-share", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "django-knowledge-share", "package_url": "https://pypi.org/project/django-knowledge-share/", "platform": "", "project_url": "https://pypi.org/project/django-knowledge-share/", "project_urls": { "Homepage": "https://github.com/vintasoftware/django-knowledge-share" }, "release_url": "https://pypi.org/project/django-knowledge-share/0.2.0/", "requires_dist": null, "requires_python": "", "summary": "App to create a microblog for sharing knowledge.", "version": "0.2.0" }, "last_serial": 3760026, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "84a6e6958aa8b78cba14962bda14a8fb", "sha256": "3f6b1b880d6b028379a21c4f8f5236dfff089ff50e075456b791642c2a1a257b" }, "downloads": -1, "filename": "django_knowledge_share-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "84a6e6958aa8b78cba14962bda14a8fb", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 12115, "upload_time": "2017-02-23T20:48:51", "url": "https://files.pythonhosted.org/packages/a2/69/712e05c40ea8e5eab6ddacd1fffae701c9329b607e361280c85cff809aa2/django_knowledge_share-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ed80aab334783944471a49cd1a92002b", "sha256": "58ea5e783d9bdc51e031fea0407456829164fcbe3dae75ff153601ef55f85a1d" }, "downloads": -1, "filename": "django-knowledge-share-0.1.0.tar.gz", "has_sig": false, "md5_digest": "ed80aab334783944471a49cd1a92002b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8520, "upload_time": "2017-02-23T20:48:48", "url": "https://files.pythonhosted.org/packages/3a/3d/2c3cd109faf57c510e219922e737bba313dd8c73f3ee354b640d579f364f/django-knowledge-share-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "57bbf5f0c3031fea77da9792dfd33ca8", "sha256": "155da00fe1f9d933e2c6a847ede8bb18da235904aa6337d8cd7f6fb79620082a" }, "downloads": -1, "filename": "django_knowledge_share-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "57bbf5f0c3031fea77da9792dfd33ca8", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 12238, "upload_time": "2017-03-09T19:53:42", "url": "https://files.pythonhosted.org/packages/6d/00/76fa74a74da3ac325a31f5efb59a795dae0fb6d842511c1adec8f0b3f88b/django_knowledge_share-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a407b5d274b82288a9bf5bbbe7209609", "sha256": "5170be0ec0c1c3cbc10c532f1d13a475a3546ac295e53b1be074791e93632411" }, "downloads": -1, "filename": "django-knowledge-share-0.1.1.tar.gz", "has_sig": false, "md5_digest": "a407b5d274b82288a9bf5bbbe7209609", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8607, "upload_time": "2017-03-09T19:53:39", "url": "https://files.pythonhosted.org/packages/2e/18/7ac495624ac8f57d9862e9d9181c3412a6b84d880fbfcb2e551bd4016b46/django-knowledge-share-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "c9b4d023688eb4ae125a75d436294ba7", "sha256": "e7c2ef9a775bb38e105374673d082c3452619da204c8d0765d010b24b72b5640" }, "downloads": -1, "filename": "django_knowledge_share-0.1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c9b4d023688eb4ae125a75d436294ba7", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 12344, "upload_time": "2017-03-09T21:16:16", "url": "https://files.pythonhosted.org/packages/d0/77/64f753725a1b93812bf5d408772715bc01abfa9d38ad85db30cbfa1b8f64/django_knowledge_share-0.1.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c9524db5651858309ecae8d65f00e7e9", "sha256": "8396ffb65641164bf729993b27e56c59d7fdad554381e6c42a88b42b8968a6ac" }, "downloads": -1, "filename": "django-knowledge-share-0.1.2.tar.gz", "has_sig": false, "md5_digest": "c9524db5651858309ecae8d65f00e7e9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8667, "upload_time": "2017-03-09T21:16:13", "url": "https://files.pythonhosted.org/packages/2b/dd/a68e85f31f7e607c35e7390e8b17c3a1612fa9ae6d2a69577501edc47811/django-knowledge-share-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "2e1aac5aff9237d495d796f3ff727fff", "sha256": "09b1545bb48b87888fc392d66ab82ed74c539b0e671fe355e8a0db374755c82f" }, "downloads": -1, "filename": "django-knowledge-share-0.1.3.tar.gz", "has_sig": false, "md5_digest": "2e1aac5aff9237d495d796f3ff727fff", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8844, "upload_time": "2017-10-04T22:50:30", "url": "https://files.pythonhosted.org/packages/43/b1/ba14a2f843031c343022a256bbe0cbf6792a76dcf3813c5e9d29816183c4/django-knowledge-share-0.1.3.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "f363105e42419dbbf4d39ca9da945034", "sha256": "6069f313e509c6958393dbfeba617472dfd63406bf867be4594fe01ba59deb2f" }, "downloads": -1, "filename": "django-knowledge-share-0.2.0.tar.gz", "has_sig": false, "md5_digest": "f363105e42419dbbf4d39ca9da945034", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10409, "upload_time": "2018-04-12T21:28:03", "url": "https://files.pythonhosted.org/packages/4e/f6/d3128bae28aa6057f6d4221641dc61c4601b431bcc5608c3e3ee99f0e2bb/django-knowledge-share-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f363105e42419dbbf4d39ca9da945034", "sha256": "6069f313e509c6958393dbfeba617472dfd63406bf867be4594fe01ba59deb2f" }, "downloads": -1, "filename": "django-knowledge-share-0.2.0.tar.gz", "has_sig": false, "md5_digest": "f363105e42419dbbf4d39ca9da945034", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10409, "upload_time": "2018-04-12T21:28:03", "url": "https://files.pythonhosted.org/packages/4e/f6/d3128bae28aa6057f6d4221641dc61c4601b431bcc5608c3e3ee99f0e2bb/django-knowledge-share-0.2.0.tar.gz" } ] }