bypy 1.3.0

Python client for Baidu Yun (Personal Cloud Storage) 百度云/百度网盘 Python 客户端

bypy - Python client for Baidu Yun (Personal Cloud Storage)
百度云/百度网盘Python客户端

==== |alt text| |alt text| |alt text| |Coverage Status| |Code Climate|
|Join the chat at https://gitter.im/houtianze/bypy|

===

中文说明 (English readme is at the bottom)
------------------------------------------

这是一个百度云/百度网盘的Python客户端。主要的目的就是在Linux环境下（Windows下应该也可用，但没有仔细测试过）通过命令行来使用百度云盘的2TB的巨大空间。比如，你可以用在Raspberry
Pi树莓派上。它提供文件列表、下载、上传、比较、向上同步、向下同步，等操作。

**由于百度PCS
API权限限制，程序只能存取百度云端\ ``/apps/bypy``\ 目录下面的文件和目录。**

**特征: 支持Unicode/中文；失败重试；递归上传/下载；目录比较;
哈希缓存。**

界面是英文的，主要是因为这个是为了Raspberry Pi树莓派开发的。

程序依赖
--------

**重要：想要支持中文，你要把系统的区域编码设置为UTF-8。（参见：http://perlgeek.de/en/article/set-up-a-clean-utf8-environment)**

**重要：你需要安装\ `Python Requests
库 <http://www.python-requests.org/>`__. 在 Debian / Ubuntu / Raspbian**
环境下，只需执行如下命令一次：

::

sudo pip install requests

安装
----

- 接通过\ ``pip``\ 来安装：\ ``pip install bypy`` （支持Python 2.7+,
3.3+)

运行
----

- 作为独立程序: 运行 ``bypy``
(或者``python -m bypy``\ ，或者\ ``python3 -m bypy``\ ）

可以看到命令行支持的全部命令和参数。 - 作为一个包，在代码中使用:
``import bypy``

简单的图形界面： 运行 ``bypygui``

要找多线程图形界面的，这个貌似不错：\ `bcloud <../../../../LiuLang/bcloud>`__

基本操作
--------

显示使用帮助和所有命令（英文）:

::

bypy

第一次运行时需要授权，只需跑任何一个命令（比如
``bypy info``\ ）然后跟着说明（登陆等）来授权即可。授权只需一次，一旦成功，以后不会再出现授权提示.

更详细的了解某一个命令：

::

bypy help <command>

显示在云盘（程序的）根目录下文件列表：

::

bypy list

把当前目录同步到云盘：

::

bypy syncup

or

::

bypy upload

把云盘内容同步到本地来：

::

bypy syncdown

or

::

bypy downdir /

**比较本地当前目录和云盘（程序的）根目录（个人认为非常有用）：**

::

bypy compare

更多命令和详细解释请见运行\ ``bypy``\ 的输出。

调试
----

- 运行时添加\ ``-v``\ 参数，会显示进度详情。
- 运行时添加\ ``-d``\ ，会显示一些调试信息。
- 运行时添加\ ``-ddd``\ ，还会会显示HTTP通讯信息（\ **警告：非常多**\ ）

经验分享
--------

请移步至\ `wiki <../../wiki>`__\ ，方便分享/交流。

=== Introduction --- This is a Python client for Baidu Yun (a.k.a PCS -
Personal Cloud Storage), an online storage website offering 2 TB (fast)
free personal storage. This main purpose is to be able to utilize this
stoarge service under Linux environment (console), e.g. Raspberry Pi.

**Due to Baidu PC permission restrictions, this program can only access
your ``/apps/bypy`` directoy at Baidu PCS**

**Features: Unicode / Chinese support; Retry on failures; Recursive
down/up-load; Directory comparison; Hash caching.**

Prerequisite
------------

**Important: You need to set you system locale encoding to UTF-8 for
this to work (You can refere here:
http://perlgeek.de/en/article/set-up-a-clean-utf8-environment)**

**Important: You need to install the `Python Requests
library <http://www.python-requests.org/>`__.** In Debian / Ubuntu /
Raspbian, you just run the following command:

::

sudo pip install requests

Installation
------------

- ``sudo pip install bypy`` (Supports Python 2.7+, 3.3+)

Usage
-----

- Standalone program
- Simply run ``bypy`` (or ``python -m bypy``, or
``python3 -m bypy``\ ） You will see all the commands and parameters
it supports

- As a package in your code
- ``import bypy``

Simple GUI: Run ``bypygui``

For advanced GUI with parallel downloading capbility, this seems a good
choice: `bcloud <../../../../LiuLang/bcloud>`__

Getting started
---------------

To get help and a list of available commands:

::

bypy

To authorize for first time use, run any commands e.g. ``bypy info`` and
follow the instructions (login etc). This is a one-time requirement
only.

To get more details about certain command:

::

bypy help <command>

List files at (App's) root directory at Baidu PCS:

::

bypy list

To sync up to the cloud (from the current directory):

::

bypy syncup

or

::

bypy upload

To sync down from the cloud (to the current directory):

::

bypy syncdown

or

::

bypy downdir /

**To compare the current directory to (App's) root directory at Baidu
PCS (which I think is very useful):**

::

bypy compare

To get more information about the commands, check the output of
``bypy``.

Debug
-----

- Add in ``-v`` parameter, it will print more details about the
progress.
- Add in ``-d`` parameter, it will print some debug messages.
- Add in ``-ddd``, it will display HTTP messages as well (**Warning: A
lot**\ ）

Tips / Sharing
--------------

Please go to `wiki <../../wiki>`__

===

PCS API Document:
http://developer.baidu.com/wiki/index.php?title=docs/pcs/rest/file\_data\_apis\_list

=== Copyright 2015: Hou Tianze and contributors (see
https://github.com/houtianze/bypy/graphs/contributors for more details)
License: MIT

.. |alt text| image:: https://img.shields.io/pypi/v/bypy.svg
:target: https://pypi.python.org/pypi/bypy
.. |alt text| image:: https://img.shields.io/pypi/dm/bypy.svg
:target: https://pypi.python.org/pypi/bypy
.. |alt text| image:: https://travis-ci.org/houtianze/bypy.svg
:target: https://travis-ci.org/houtianze/bypy
.. |Coverage Status| image:: https://coveralls.io/repos/houtianze/bypy/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/houtianze/bypy?branch=master
.. |Code Climate| image:: https://codeclimate.com/github/houtianze/bypy/badges/gpa.svg
:target: https://codeclimate.com/github/houtianze/bypy
.. |Join the chat at https://gitter.im/houtianze/bypy| image:: https://badges.gitter.im/Join%20Chat.svg
:target: https://gitter.im/houtianze/bypy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge


Version History:
~~~~~~~~~~~~~~~~

- 1.3.0: Major change: Make bypy a real Python package

--------------

- 1.2.22: Fix "TypeError: b'xxxxxx' is not JSON serializable" for cache
- 1.2.21: Support aria2 downloading resuming (disable preallocation)
- 1.2.20: Fix an error in upload resuming; Add in retries for aria2
- 1.2.19: Add in aria2 download support
- 1.2.18: Add in upload resuming using slices; Fix Unicode issue with
py2\_jsondump(); Fix the pypi setup package
- 1.2.17: Fix UnicodeEncodeError on redirect; Add in retry on urllib3
TimeOutError
- 1.2.16: Add in proxy prompts
- 1.2.15: Fix a severe bug (accidental directory deletion) in
``download`` command intoduced in 1.2.14
- 1.2.14: Add in ``download`` command
- 1.2.13: Remove argcomplete; Improve encoding handling prompting
- 1.2.12: Add in (optional) argcomplete
- 1.2.11: Fix Exception in error dump introduced in 1.2.10
- 1.2.10: Handle (32, 'EPIPE'); Warn LOUDLY on encoding failures;
Remove 'is\_revision'
- 1.2.9: Fix formatex() Syntax Error; Handle (110, 'ETIMEDOUT')
- 1.2.8: Fix a Syntax Error; Handle {'error\_code': 0, 'error\_msg':
'no error'}
- 1.2.7: Fix Hash Cache JSON saving (need to using string for Hashes)
- 1.2.6: Fix Hash Cache JSON dumping (``Unicode`` again)
- 1.2.5: Add in offline (cloud) download; Fix stack printing
- 1.2.4: Fix command line parsing for Python 3 (``Unicode`` by default)
- 1.2.3: Fix GUI for Python 3
- 1.2.2: Fix division for Python 3
- 1.2.1: Make it ``universal`` (Python 2 & 3 compatible)
- 1.0.20: Initial release