Let's welcome botogram 0.1

Pietro Albini · Pietro Albini · commit a57172990b42 · 2016-02-18T19:33:54.000+01:00
This is the initial alpha release of botogram.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Pietro Albini
+Copyright (c) 2015-2016 Pietro Albini
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -1,15 +1,14 @@
 ## botogram [![Build Status](https://img.shields.io/travis/pietroalbini/botogram/master.svg)](https://travis-ci.org/pietroalbini/botogram) [![News channel](https://img.shields.io/badge/telegram_channel-@botogram__framework-0d86d7.svg?style=flat)][channel]
 
-_A microframework for Telegram bots_
+_Just focus on your bots._
 
-botogram is a MIT-licensed microframework, which aims to simplify the creation
-of [Telegram bots][1]. It offers a concise, simple API, which allows you to
-spend all your creativity in the bot, without worrying about anything else.
+botogram is a Python framework, which allows you to focus just on creating your
+[Telegram bots][1], without worrying about the underlying Bots API.
 
-It also provides a robust, fully scalable bot runner process, which will be
-able to process fastly high workloads. And as if this isn't enough, it has
-builtin support for commands, with an automatically-generated ``/help``
-command.
+While most of the libraries for Telegram out there just wrap the Bots API,
+botogram focuses heavily on the development experience, aiming to provide you
+the best API possible. Most of the Telegram implementation details are managed
+by botogram, so you can just focus on your bot.
 
 ```python
 import botogram
@@ -27,14 +26,22 @@ if __name__ == "__main__":
 You can find the documentation at [botogram.pietroalbini.io][2]. Also, you can
 get all the news about botogram in its [Telegram channel][channel].
 
-**Supported Python versions**: 3.4, 3.5
+> Please note botogram currently doesn't support some of the upstream API
+> features. All of them will be implemented in botogram 1.0
+
+**Supported Python versions**: 3.4, 3.5  
+**License**: MIT
 
 ### Installation
 
-botogram is currently in development, so a release doesn't exist yet.  
-But if you want to install it anyway, you can clone the repository and install
-it with setuptools. Be sure to have Python 3.4 (or a newer version), pip,
-virtualenv, setuptools and [invoke][3] installed:
+You can install easily botogram with pip (be sure to have Python 3.4 or higher
+installed):
+
+    $ python3 -m pip install botogram
+
+If you want to install from the source code, you can clone the repository and
+install it with setuptools. Be sure to have Python 3.4 (or a newer version),
+pip, virtualenv, setuptools and [invoke][3] installed:
 
     $ git clone https://github.com/pietroalbini/botogram.git
     $ cd botogram
@@ -44,6 +51,6 @@ On some Linux systems you might need to wrap the ``make install`` command with
 ``sudo``, if you don't have root privileges.
 
 [1]: https://core.telegram.org/bots
-[2]: http://botogram.pietroalbini.io/docs
+[2]: https://botogram.pietroalbini.io/docs
 [3]: http://www.pyinvoke.org
 [channel]: https://telegram.me/botogram_framework
diff --git a/docs/buildthedocs.yml b/docs/buildthedocs.yml
@@ -1,9 +1,20 @@
 versions:
-- name: "dev"
-  source:
-    provider: local
-    path: docs
-  directory: .
-  title: Development
-  notice: unstable
-  warning: This documentation is for the unstable and in-development version of botogram!
+
+  - name: "dev"
+    source:
+      provider: local
+      path: docs
+    directory: .
+    title: Development
+    notice: unstable
+    warning: This documentation is for the unstable and in-development version of botogram!
+
+  - name: "0.1"
+    source:
+      provider: git
+      url: .
+      checkout: release-0.1
+    directory: docs
+    title: botogram 0.1
+    notice: alpha
+    warning: null
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -0,0 +1,19 @@
+.. Copyright (c) 2016 Pietro Albini <pietro@pietroalbini.io>
+   Released under the MIT license
+
+.. _changelog:
+
+~~~~~~~~~~~~~~~~~~
+botogram changelog
+~~~~~~~~~~~~~~~~~~
+
+Here you can see what changed in every botogram release.
+
+.. _changelog-0.1:
+
+botogram 0.1
+============
+
+*Alpha release, released on February 18th, 2016*
+
+This is the initial alpha release of botogram.
diff --git a/docs/conf.py b/docs/conf.py
@@ -19,11 +19,11 @@
 master_doc = "index"
 
 project = "botogram"
-copyright = "2015 Pietro Albini"
+copyright = "2015-2016 Pietro Albini"
 author = "Pietro Albini"
 
-version = "1.0"
-release = "1.0"
+version = "0.1"
+release = "0.1"
 
 language = None
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,16 +5,17 @@
 botogram documentation
 ~~~~~~~~~~~~~~~~~~~~~~
 
-*A microframework for Telegram bots.*
+*Just focus on your bots.*
 
-botogram is a MIT-licensed microframework, which aims to simplify the creation
-of `Telegram bots`_. It offers a concise, simple API, which allows you to spend
-all your creativity in the bot, without worrying about anything else.
+botogram is a Python framework, which allows you to focus just on creating your
+`Telegram bots`_, without worrying about the underlying Bots API.
 
-It also provides a robust, fully scalable bot runner process, which will be
-able to process fastly high workloads. And as if this isn't enough, it has
-builtin support for commands, with an automatically-generated ``/help``
-command.
+While most of the libraries for Telegram out there just wrap the Bots API,
+botogram focuses heavily on the development experience, aiming to provide you
+the best API possible. Most of the Telegram implementation details are managed
+by botogram, so you can just focus on your bot.
+
+botogram is released under the MIT license.
 
 ::
 
@@ -69,6 +70,7 @@ Side notes
 .. toctree::
    :maxdepth: 2
 
+   changelog
    license
 
 .. _Telegram bots: https://core.telegram.org/bots
diff --git a/docs/install.rst b/docs/install.rst
@@ -9,10 +9,10 @@ Installation of botogram
 
 botogram is available `on the Python Packages Index`_, so you can install it
 really easily with the `pip`_ command-line utility. Before installing it, be
-sure to have Python_ 3.4 (or a newer version), pip_, virtualenv_ and setuptools_
-installed on your system. Then, issue the following command::
+sure to have Python_ 3.4 (or a newer version), pip_, virtualenv_ and
+setuptools_ installed on your system. Then, issue the following command::
 
-   $ pip3 install botogram
+   $ python3 -m pip install botogram
 
 Perfect, botogram is now installed! Now, you can follow the
 ":ref:`quickstart`" chapter if you want to create a bot right now!
@@ -25,8 +25,7 @@ Living on the edge
 
 If you don't mind having some instability or bugs, and you want the latest
 features not yet released, you can clone the `botogram git repository`_,
-install `virtualenv <virtualenv-install>`_, `invoke`_ and execute the
-installation from source::
+install `virtualenv`_, `invoke`_ and execute the installation from source::
 
    $ git clone https://github.com/pietroalbini/botogram.git
    $ cd botogram
@@ -94,5 +93,4 @@ one::
 .. _setuptools: https://setuptools.pypa.io
 .. _botogram git repository: https://github.com/pietroalbini/botogram
 .. _virtualenv: https://virtualenv.pypa.io
-.. _virtualenv-install: https://virtualenv.pypa.io/en/latest/installation.html
 .. _invoke: https://www.pyinvoke.org
diff --git a/docs/license.rst b/docs/license.rst
@@ -1,26 +1,32 @@
-.. Copyright (c) 2015 Pietro Albini <pietro@pietroalbini.io>
+.. Copyright (c) 2015-2016 Pietro Albini <pietro@pietroalbini.io>
    Released under the MIT license
 
 ~~~~~~~~~~~~~~~
 The MIT license
 ~~~~~~~~~~~~~~~
 
-Copyright (c) 2015 Pietro Albini
+botogram is released under the MIT license. This means you can use it as you
+want, change it and redistribute it, but you must keep the following copyright
+notice:
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is furnished
-to do so, subject to the following conditions:
+::
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+   Copyright (c) 2015-2016 Pietro Albini
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+   Permission is hereby granted, free of charge, to any person obtaining a copy
+   of this software and associated documentation files (the "Software"), to
+   deal in the Software without restriction, including without limitation the
+   rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+   sell copies of the Software, and to permit persons to whom the Software is
+   furnished to do so, subject to the following conditions:
+
+   The above copyright notice and this permission notice shall be included in
+   all copies or substantial portions of the Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+   IN THE SOFTWARE.
diff --git a/setup.py b/setup.py
@@ -1,19 +1,52 @@
 #!/usr/bin/python3
+'''
+========
+botogram
+========
+
+botogram is a Python framework, which allows you to focus just on
+creating your `Telegram bots`_, without worrying about the underlying
+Bots API.
+
+While most of the libraries for Telegram out there just wrap the Bots
+API, botogram focuses heavily on the development experience, aiming to
+provide you the best API possible. Most of the Telegram implementation
+details are managed by botogram, so you can just focus on your bot.
+
+::
+
+    import botogram
+    bot = botogram.create("API-KEY")
+
+    @bot.command("hello")
+    def hello_command(chat, message, args):
+        """Say hello to the world!"""
+        chat.send("Hello world")
+
+    if __name__ == "__main__":
+        bot.run()
+
+Want to get started? `Go to the documentation_`
+
+.. _Telegram bots: https://core.telegram.org/bots
+.. _Go to the documentation: https://botogram.pietroalbini.io/docs
+'''
 
 import setuptools
 
 
 setuptools.setup(
     name = "botogram",
-    version = "1.0.dev0",
-    url = "http://botogram.pietroalbini.io",
+    version = "0.1",
+    url = "https://botogram.pietroalbini.io",
 
     license = "MIT",
 
     author = "Pietro Albini",
     author_email = "pietro@pietroalbini.io",
 
-    description = "A Python microframework for Telegram bots",
+    description = "A Python framework for Telegram bots",
+    long_description = __doc__,
 
     packages = [
         "botogram",
@@ -30,7 +63,7 @@
     zip_safe = False,
 
     classifiers = [
-        "Development Status :: 2 - Pre-Alpha",
+        "Development Status :: 3 - Alpha",
         "Environment :: Other Environment",
         "Intended Audience :: Developers",
         "License :: OSI Approved :: MIT License",
