提交 e2db19d9 编写于 作者: H Hou Tianze

Update README to put project to maitenance mode

上级 87946ca0
bypy - Python client for Baidu Yun (Personal Cloud Storage) 百度云/百度网盘Python客户端
**TL;DR: `pip install bypy`. Run `bypy`**
===
====================================================================================
[![alt text](https://img.shields.io/pypi/v/bypy.svg "PyPi Version")](https://pypi.python.org/pypi/bypy)
[![alt text](https://img.shields.io/pypi/dm/bypy.svg "PyPi Downloads")](https://pypi.python.org/pypi/bypy)
......@@ -9,33 +7,55 @@ bypy - Python client for Baidu Yun (Personal Cloud Storage) 百度云/百度网
[![Coverage Status](https://coveralls.io/repos/houtianze/bypy/badge.svg?branch=master&service=github)](https://coveralls.io/github/houtianze/bypy?branch=master)
[![Code Climate](https://codeclimate.com/github/houtianze/bypy/badges/gpa.svg)](https://codeclimate.com/github/houtianze/bypy)
[![Join the chat at https://gitter.im/houtianze/bypy](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/houtianze/bypy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
极简说明:
--------
- 安装: `pip install bypy`
- 运行: `bypy`
TL;DR:
------
- To install: `pip install bypy`
- To use: `bypy`
**此项目已经进入维护状态:不会再有新的功能加入,只有在发现重大bug情况下才会有 _可能_ 更新。**
**This is project is now in "maintenance" mode: NO new features will be added, and _may_ be updated only if critical bugs are found.**
---
中文说明 (English readme is at the bottom)
---
-----------------------------------------
- 最新: 目录上传/下载/同步加入了多进程支持(`--processes`
---
这是一个百度云/百度网盘的Python客户端。主要的目的就是在Linux环境下(Windows下应该也可用,但没有仔细测试过)通过命令行来使用百度云盘的2TB的巨大空间。比如,你可以用在Raspberry Pi树莓派上。它提供文件列表、下载、上传、比较、向上同步、向下同步,等操作。
**由于百度PCS API权限限制,程序只能存取百度云端`/apps/bypy`目录下面的文件和目录。**
**据说百度PCS API最多返回目录下1000个文件( #306 ),如果属实,百度云盘上若有超过1000个文件的目录,将有一部分文件无法被看到 / 下载**
**(已解决)~~据说百度PCS API最多返回目录下1000个文件( #285 ),如果属实,百度云盘上若有超过1000个文件的目录,将有一部分文件无法被看到 / 下载~~**
**特征: 支持Unicode/中文;失败重试;递归上传/下载;目录比较; 哈希缓存。**
界面是英文的,主要是因为这个是为了Raspberry Pi树莓派开发的。
程序依赖
---
**重要:需要把系统的区域编码设置为UTF-8。(参见:http://perlgeek.de/en/article/set-up-a-clean-utf8-environment)**
------
**重要:需要把系统的区域编码设置为UTF-8。(参见:<http://perlgeek.de/en/article/set-up-a-clean-utf8-environment>)**
安装
---
- 通过`pip`来安装:`pip install bypy` (支持Python 2.7+, 3.3+)
运行
---
- 作为独立程序: 运行 `bypy` (或者`python -m bypy`,或者`python3 -m bypy`
可以看到命令行支持的全部命令和参数。
......@@ -44,10 +64,9 @@ bypy - Python client for Baidu Yun (Personal Cloud Storage) 百度云/百度网
简单的图形界面:
运行 `bypygui`
要找多线程图形界面的,这个貌似不错:[bcloud](../../../../LiuLang/bcloud)
基本操作
---
------
显示使用帮助和所有命令(英文):
```
bypy
......@@ -92,17 +111,20 @@ bypy compare
调试
---
- 运行时添加`-v`参数,会显示进度详情。
- 运行时添加`-d`,会显示一些调试信息。
- 运行时添加`-ddd`,还会会显示HTTP通讯信息(**警告:非常多**
经验分享
---
-------
请移步至[wiki](../../wiki),方便分享/交流。
直接在Python程序中调用
----
-------------------
```python
from bypy import ByPy
bp=ByPy()
......@@ -110,36 +132,43 @@ bp.list() # or whatever instance methods of ByPy class
```
授权许可
---
-------
请阅: [LICENSE](LICENSE)
---
Introduction
PCS API文档(已失效): http://developer.baidu.com/wiki/index.php?title=docs/pcs/rest/file_data_apis_list (以前保存的离线版: [baidudoc](baidudoc) directory)
---
Introduction
------------
- Latest feature: Multiprocessing added to directory upload / download / sync(`--processes`
---
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**
**It's said the Baidu PCS API won't return more than 1000 items inside a directory ( #306 ),if this is true,you won't be able to see / download some files if you have a directoyr with more than 1000 files on Baidu Cloud**
**(Fixed) ~~It's said the Baidu PCS API won't return more than 1000 items inside a directory ( #306 ),if this is true,you won't be able to see / download some files if you have a directory with more than 1000 files on Baidu Cloud~~**
**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 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)**
Installation
---
- `pip install bypy` (Supports Python 2.7+, 3.3+)
------------
- `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
......@@ -150,10 +179,9 @@ Usage
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
......@@ -197,24 +225,26 @@ 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)
To call from Python code
----
------------------------
```python
from bypy import ByPy
bp=ByPy()
bp.list() # or whatever instance methods of ByPy class
```
License
---
......@@ -222,4 +252,4 @@ Please refer to [LICENSE](LICENSE)
---
PCS API Document: http://developer.baidu.com/wiki/index.php?title=docs/pcs/rest/file_data_apis_list
PCS API Document (link dead 404): http://developer.baidu.com/wiki/index.php?title=docs/pcs/rest/file_data_apis_list (Offline pdf retrieved before: [baidudoc](baidudoc) directory)
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册