Merge branch 'release/0.3.3'

CHANGELOG.md

@@ -5,7 +5,27 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Release
-### [0.3.2] - TBD
+### [0.3.3] - 2018-02-17
+
+#### Added
+- List support for servers that support it. (See ``help list`` for more details.)
+- Bumped to Mastodon.py 1.2.2
+
+#### Added (awaiting proper config)
+( The following items are active but require a re-working of the configuration file to make active. Currently they are flags inside the ``toot_parser.py`` file. Intrepid explorers may find them.)
+- Added emoji shortcode (defaults to "off").
+- Added emoji "demoji" to show shortcodes for emoji (defaults to off).
+
+#### Fixed
+- Fixed boosting private toots
+- Fixed message for boosting toots
+- Fixed leading / trailing whitespace from media filepath
+- Added better exception handling around streaming API
+
+####
+
+### Release
+### [0.3.2] - 2017-12-23
 
 #### Added
 - Reworked the Tootstream Parser to add styling, link-shortening, link retrieval, and emoji code shortening

README.md

@@ -56,11 +56,23 @@ $ python3 setup.py install
 $ source /path/to/tootstream/bin/activate
 ```
 
-2: Run the script
+2: Run the program
 ```
 $ tootstream
 ```
-3: Close the environment with `$ deactivate`
+
+3: Use the ``help`` command to see the available commands
+```
+[@myusername (default)]: help
+```
+
+4: Exit the program when finished
+```
+[@myusername (default)]: quit
+
+```
+
+5: Close the environment with `$ deactivate`
 
 ## Ubuntu and Unicode
 
@@ -70,6 +82,26 @@ Tootstream relies heavily on Unicode fonts. The best experience can be had by in
 $ sudo apt-get install ttf-ancient-fonts
 ```
 
+## Configuration
+
+By default tootstream uses [configparser](https://docs.python.org/3/library/configparser.html) for configuration. The default configuration is stored in the default location for configparser (on the developer's machine this is under /home/myusername/.config/tootstream/tootstream.conf). 
+
+At the moment tootstream only stores login information for each instance in the configuration file. Each instance is under its own section (the default configuration is under the ``[default]`` section). Multiple instances can be stored in the ``tootstream.conf`` file. (See "Using multiple instances")
+
+## Using multiple instances
+
+Tootstream supports using accounts on multiple Mastodon instances.
+
+Use the ``--instance`` parameter to pass the server location (in the case of Mastodon.social we'd use ``--instance mastodon.social``).
+
+Use the ``--profile`` parameter to use a different named profile. (in the case of Mastodon.social we could call it ``mastodon.social`` and name the section using ``--profile mastodon.social``).
+
+By default tootstream uses the ``[default]`` profile. If this already has an instance associated with it then tootstream will default to using that instance.
+
+If you have already set up a profile you may use the ``--profile`` command-line switch to start tootstream with it. The ``--instance`` parameter is optional (and redundant).
+
+You may select a different configuration using ``--config`` and pass it the full-path to that file.
+
 ## Contributing
 
 Contributions welcome! Please read the [contributing guidelines](CONTRIBUTING.md) before getting started.

requirements.txt

@@ -1,5 +1,5 @@
 click>=6.7
-Mastodon.py==1.2.1
+Mastodon.py==1.2.2
 colored>=1.3.5
 humanize>=0.5.1
 emoji>=0.4.5

setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 setup(
     name="tootstream",
-    version="0.3.2",
+    version="0.3.3",
     python_requires=">=3",
     install_requires=[line.strip() for line in open('requirements.txt')],