fanfou-cli 0.1.20

Fanfou Command Line Client

饭否命令行客户端
################

.. image:: https://travis-ci.org/j178/fanfou-cli.svg?branch=master
:target: https://travis-ci.org/j178/fanfou-cli

.. image:: https://badge.fury.io/py/fanfou-cli.svg
:target: https://pypi.python.org/pypi/fanfou-cli

.. image:: https://img.shields.io/badge/python-3.5-blue.svg
:target: https://pypi.python.org/pypi/fanfou-cli

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://pypi.python.org/pypi/fanfou-cli

.. image:: https://badges.gitter.im/fanfou-cli2/Lobby.svg
:target: https://gitter.im/fanfou-cli2/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge


安装
====

- 通过 `pip`_ 安装

.. code-block:: bash

pip3 install fanfou-cli

- 手动安装

.. code-block:: bash

git clone https://github.com/j178/fanfou-cli
cd fanfou-cli
pip3 install . --user

使用
====

日常使用
--------

.. code-block:: bash

fan 任意文字，不需要引号，可以包含空格，fan命令之后的任意内容均被当作新饭的内容


其他功能
--------

.. table::
:widths: 25

====================== ====================================================
fan 不加任何参数直接运行 ``fan`` , 则在默认浏览器中打开饭否主页
fan [文字] -i <image> 上传图片。``-i`` 参数可以是图片的本地路径或者网络URL，网络URL请用引号引起来。文字可以为空。
fan - ``fan`` 命令后加短横线 ``-`` ，表示从标准输入(stdin)中读取内容。
这样就可以输入多行的饭，输入完成后按 ``Ctrl+D`` (Windows下 ``Ctrl+Z`` )结束输入。
也可以与其他命令结合起来使用，如 ``echo 'hello' | fan -``
fan -r 撤回上一条饭
fan -v 刷饭模式
fan -m 查看自己的饭否资料
fan -d 随机查看一些公开的饭
fan -u <user-id> 查看他人的资料，``user-id`` 可从 ``fan -v`` 模式中获得
fan --login 登陆新的账号
fan --switch 切换账号
fan --config 自定义配置
fan --lock 1 上锁。非关注者无法查看你的状态。
fan --lock 0 解锁
fan --dump [文件名] 将所有饭否消息保存为JSON格式。文件名可选，默认为 ``fanfou-archive.json``
fan -h 查看帮助
====================== ====================================================

初次使用时，此工具需要获取你的授权才能帮你发饭。
此工具支持两种授权方式：
- 一种是 OAuth，这种方式无需获取你的密码，是默认的授权方式。
- 另一种是 XAuth，这种方式需要你输入用户名和密码（输入密码时自动关闭回显），适合在没有浏览器的场景使用，在使用 ``--xauth`` 参数时会使用此种方式。

**你的密码仅在初次授权时需要，此工具不会保存。**

如果你想取消对此工具的授权，可以随时访问 `<http://fanfou.com/settings/apps>`_, 找到 **爱米饭**， 然后 **取消认证** 就可以了啦~

说明
====

- 此工具会在 ``~/.fancache`` (\*unix系统)或 ``%USERPROFILE%/.fancache`` 中保存认证凭据(access_token)，用户的饭否资料，和你的最新的一条饭否消息。你可以随时删除这个文件，不过删除之后需要重新授权。
- OAuth认证时，此工具会启动一个 HTTP服务器，并监听本地的 8000 端口。Windows下会弹出权限提示，为了能够正常授权，请选择允许。
- 上锁/解锁功能需要你在浏览器中的 cookie。在浏览器中打开饭否页面，然后按F12打开控制台，执行以下 Javascript 代码，将代码的输出结果粘贴到脚本中。

.. code-block:: javascript

(/al=(.*?);/i).exec(document.cookie)[1]

依赖
====

- Python3
- requests-oauthlib
- arrow

TODO
====

- [x] 图片上传
- [x] colorize
- [x] time humanize
- [x] 转发/评论消息
- [x] 上锁/解锁功能
- [x] 简化授权流程
- [x] 查看图片
- [x] xauth支持
- [x] 修改配置功能
- [x] 多账号切换
- [ ] 备份进度条
- [ ] 查看提到我的消息
- [ ] 查看私信

.. _pip: https://pip.pypa.io/en/stable/installing/