Merge pull request #45 from ymyzk/rename

Rename this project

README.rst

@@ -1,5 +1,5 @@
-django-channels
-===============
+kawasemi
+========
 .. image:: https://badge.fury.io/py/django-channels.svg
    :target: https://pypi.python.org/pypi/django-channels/
    :alt: PyPI version
@@ -19,11 +19,11 @@ django-channels
    :target: https://requires.io/github/ymyzk/django-channels/requirements/?branch=master
    :alt: Requirements Status
 
-django-channels is a Django library for sending notifications.
+**kawasemi** is a Django library for sending notifications.
 HipChat, Slack, Twitter and Yo are supported for now.
 
-**Note:** This should not be confused with the official Django Channels
-project which you can see at https://channels.readthedocs.io/.
+**Note:** This project was named *django-channels*.
+We renamed our project not to be confused with the official `Django Channels`_.
 
 At a Glance
 -----------
@@ -32,9 +32,9 @@ Slack, Twitter, or Yo with a following simple code:
 
 .. code-block:: python
 
-   import channels
+   import kawasemi
 
-   channels.send("Sample notification.")
+   kawasemi.send("Sample notification.")
 
 See `Quickstart`_ page for more details.
 
@@ -59,13 +59,13 @@ Installation
 
 .. code-block:: shell
 
-   pip install django-channels
+   pip install kawasemi
 
-Note: Please use the latest version of setuptools & pip
+Note: Please use the latest version of setuptools, pip, and wheel.
 
 .. code-block:: shell
 
-   pip install -U setuptools pip
+   pip install -U setuptools pip wheel
 
 
 Links
@@ -76,3 +76,4 @@ Links
 .. _Documentation: https://django-channels.readthedocs.io/
 .. _GitHub: https://github.com/ymyzk/django-channels
 .. _Quickstart: https://django-channels.readthedocs.io/en/latest/quickstart.html
+.. _Django Channels: https://channels.readthedocs.io/

docs/Makefile

@@ -91,9 +91,9 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-channels.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/kawasemi.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-channels.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/kawasemi.qhc"
 
 .PHONY: applehelp
 applehelp:
@@ -110,8 +110,8 @@ devhelp:
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/django-channels"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-channels"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/kawasemi"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/kawasemi"
 	@echo "# devhelp"
 
 .PHONY: epub

docs/make.bat

@@ -129,9 +129,9 @@ if "%1" == "qthelp" (
 	echo.
 	echo.Build finished; now you can run "qcollectiongenerator" with the ^
 .qhcp project file in %BUILDDIR%/qthelp, like this:
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\django-channels.qhcp
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\kawasemi.qhcp
 	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\django-channels.ghc
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\kawasemi.ghc
 	goto end
 )
 

docs/source/backends/hipchat.rst

@@ -2,7 +2,7 @@ HipChat
 =======
 `HipChat`_ is hosted group chat and video chat for companies and teams.
 
-django-channels uses one of the `Room API`_ for sending notification to HipChat.
+kawasemi uses one of the `Room API`_ for sending notification to HipChat.
 
 Settings
 --------
@@ -13,7 +13,7 @@ You can obtain a Room API ID and a Room Notification Token from `HipChat Rooms P
    CHANNELS = {
        "CHANNELS": {
            "hipchat": {
-               "_backend": "channels.backends.hipchat.HipChatChannel",
+               "_backend": "kawasemi.backends.hipchat.HipChatChannel",
                # Required
                # Room API ID
                "api_id": "1234567",
@@ -40,9 +40,9 @@ You can specify all options available in the `Room API`_. For instance:
 
 .. code-block:: python
 
-   import channels
+   import kawasemi
 
-   channels.send("Sample notification.", options={
+   kawasemi.send("Sample notification.", options={
        "hipchat": {
            "color": "green",
            "notify": False,

docs/source/backends/slack.rst

@@ -2,7 +2,7 @@ Slack
 =====
 `Slack`_ is a platform for team communication.
 
-django-channels uses `Incoming WebHooks`_ which is one of the `Slack API`_ for sending notifications.
+kawasemi uses `Incoming WebHooks`_ which is one of the `Slack API`_ for sending notifications.
 
 Settings
 --------
@@ -13,12 +13,12 @@ You can obtain a Webhook URL from `this page`_.
    CHANNELS = {
        "CHANNELS": {
            "slack": {
-               "_backend": "channels.backends.slack.SlackChannel",
+               "_backend": "kawasemi.backends.slack.SlackChannel",
                # Required
                # Webhook URL
                "url": "https://hooks.slack.com/services/ABCDEF/GHIJKLM/1234567890",
                # Optional
-               "username": "django-channels",
+               "username": "kawasemi",
                # You can set either icon_url or icon_emoji
                "icon_url": "https://slack.com/img/icons/app-57.png",
                "icon_emoji": ":ghost:",
@@ -41,9 +41,9 @@ For more information on ``attachments``, please refer to `Attachments`_.
 .. image:: slack_attachments_example.png
 .. code-block:: python
 
-   import channels
+   import kawasemi
 
-   channels.send("Test message with attachments", options={
+   kawasemi.send("Test message with attachments", options={
        "slack": {
            "attachments": [
                {
@@ -83,9 +83,9 @@ For more details on ``unfurl_links``, please refer to `Unfurling`_.
 
 .. code-block:: python
 
-   import channels
+   import kawasemi
 
-   channels.send("Sample notification.", options={
+   kawasemi.send("Sample notification.", options={
        "slack": {
            "unfurl_links": True
        }

docs/source/backends/twitter.rst

@@ -2,7 +2,7 @@ Twitter
 =======
 `Twitter`_ is an online social networking service that enables users to send and read short 140-character messages called "tweets".
 
-django-channels uses `one`_ of the `REST APIs`_ for sending tweets.
+kawasemi uses `one`_ of the `REST APIs`_ for sending tweets.
 
 Settings
 --------
@@ -13,7 +13,7 @@ You can obtain keys and access tokens from `Twitter Application Management`_.
    CHANNELS = {
        "CHANNELS": {
            "twitter": {
-                "_backend": "channels.backends.twitter.TwitterChannel",
+                "_backend": "kawasemi.backends.twitter.TwitterChannel",
                 # Required
                 # Consumer Key (API Key)
                 "api_key": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
@@ -33,9 +33,9 @@ You can specify all parameters available in the `API`_. For instance:
 
 .. code-block:: python
 
-   import channels
+   import kawasemi
 
-   channels.send("Sample tweet with location.", options={
+   kawasemi.send("Sample tweet with location.", options={
        "twitter": {
            "lat": 37.7821120598956,
            "long": -122.400612831116

docs/source/backends/yo.rst

@@ -2,7 +2,7 @@ Yo
 ==
 `Yo`_ is the simplest and most efficient communication tool in the world.
 
-django-channels uses one of the `API`_ for sending Yos.
+kawasemi uses one of the `API`_ for sending Yos.
 
 Settings
 --------
@@ -13,7 +13,7 @@ You can obtain an API token from `Yo Dashboard`_.
    CHANNELS = {
        "CHANNELS": {
            "yo": {
-               "_backend": "channels.backends.yo.YoChannel",
+               "_backend": "kawasemi.backends.yo.YoChannel",
                # Required
                # Your API token
                "api_token": environ.get("CHANNELS_YO_API_TOKEN"),
@@ -30,10 +30,10 @@ You can send Yo with text (30 characters max) with Yo API v2.0.
 
 .. code-block:: python
 
-   import channels
+   import kawasemi
 
    # Yo with text
-   self.channel.send("text")
+   kawasemi.send("text")
 
 
 Options
@@ -42,17 +42,17 @@ You can send Yo Location or Yo Link by specifying options. For example:
 
 .. code-block:: python
 
-   import channels
+   import kawasemi
 
    # Yo Link
-   self.channel.send(None, options={
+   kawasemi.send(None, options={
        "yo": {
            "link": "http://docs.justyo.co/v1.0/docs/yo"
        }
    })
 
    # Yo Location
-   self.channel.send(None, options={
+   kawasemi.send(None, options={
        "yo": {
            "location": "35.0261581,135.7818476"
        }

docs/source/conf.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
-# django-channels documentation build configuration file, created by
+# kawasemi documentation build configuration file, created by
 # sphinx-quickstart on Sat Sep 24 16:15:04 2016.
 #
 # This file is execfile()d with the current directory set to its
@@ -54,8 +54,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = 'django-channels'
-copyright = '2015-2016, Yusuke Miyazaki'
+project = 'kawasemi'
+copyright = '2015-2017, Yusuke Miyazaki'
 author = 'Yusuke Miyazaki'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -139,7 +139,7 @@
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
 #
-# html_title = 'django-channels v0.7.0'
+# html_title = 'kawasemi v0.7.0'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #
@@ -239,7 +239,7 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'django-channelsdoc'
+htmlhelp_basename = 'kawasemidoc'
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -265,7 +265,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'django-channels.tex', 'django-channels Documentation',
+    (master_doc, 'kawasemi.tex', 'kawasemi Documentation',
      'Yusuke Miyazaki', 'manual'),
 ]
 
@@ -307,7 +307,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'django-channels', 'django-channels Documentation',
+    (master_doc, 'kawasemi', 'kawasemi Documentation',
      [author], 1)
 ]
 
@@ -322,8 +322,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'django-channels', 'django-channels Documentation',
-     author, 'django-channels', 'One line description of project.',
+    (master_doc, 'kawasemi', 'kawasemi Documentation',
+     author, 'kawasemi', 'One line description of project.',
      'Miscellaneous'),
 ]
 

docs/source/index.rst

@@ -1,6 +1,6 @@
-django-channels
-===============
-django-channels is a Django library for sending notifications.
+kawasemi
+========
+**kawasemi** is a Django library for sending notifications.
 HipChat, Slack, Twitter, and Yo are supported for now.
 
 At a Glance
@@ -10,9 +10,9 @@ you can send notifications to HipChat, Slack, Twitter, or Yo with a following si
 
 .. code-block:: python
 
-   import channels
+   import kawasemi
 
-   channels.send("Sample notification.")
+   kawasemi.send("Sample notification.")
 
 Requirements
 ------------