{"id":21037433,"url":"https://github.com/vintasoftware/django-knowledge-share","last_synced_at":"2025-05-15T14:32:46.326Z","repository":{"id":17274858,"uuid":"81183745","full_name":"vintasoftware/django-knowledge-share","owner":"vintasoftware","description":"The engine behind Vinta's Lessons Learned page.","archived":false,"fork":false,"pushed_at":"2022-12-26T20:29:46.000Z","size":83,"stargazers_count":37,"open_issues_count":9,"forks_count":1,"subscribers_count":22,"default_branch":"master","last_synced_at":"2025-04-19T03:11:04.648Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://vintasoftware.com/lessons-learned/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vintasoftware.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-07T08:14:48.000Z","updated_at":"2024-06-14T22:49:01.000Z","dependencies_parsed_at":"2023-01-13T19:14:59.552Z","dependency_job_id":null,"html_url":"https://github.com/vintasoftware/django-knowledge-share","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vintasoftware%2Fdjango-knowledge-share","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vintasoftware%2Fdjango-knowledge-share/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vintasoftware%2Fdjango-knowledge-share/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vintasoftware%2Fdjango-knowledge-share/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vintasoftware","download_url":"https://codeload.github.com/vintasoftware/django-knowledge-share/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254359018,"owners_count":22058033,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T13:26:13.653Z","updated_at":"2025-05-15T14:32:45.987Z","avatar_url":"https://github.com/vintasoftware.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"=============================\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\u003cknowledge_share/models.py\u003e`_. 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 \u003chttps://my.slack.com/services/new/slash-commands\u003e`_.\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    \u003ca href=\"https://twitter.com/intent/tweet?text={{ post|format_post }}\"\u003e\n        Share on twitter\n    \u003c/a\u003e\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 \u003cYOURVIRTUALENV\u003e/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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvintasoftware%2Fdjango-knowledge-share","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvintasoftware%2Fdjango-knowledge-share","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvintasoftware%2Fdjango-knowledge-share/lists"}