pdfebc工具的核心功能。pdfebc工具是一套将pdf文件压缩为电子阅读器友好大小的工具。
pdfebc-core的Python项目详细描述
内容
Overview
pdfebc计划成为一套将pdf文件压缩为电子阅读器友好大小的工具, 也可以选择通过电子邮件发送到kindle等。这个包包含核心 可由不同用户界面使用的功能。目前,我正计划创建 一个cli、一个web界面和一个桌面gui。这对我来说是一个实践项目,但是 这对我很有用(至少cli版本,其他的只是练习)。
作为一个示例用例,我主要使用pdfebc作为压缩演讲幻灯片和 类似的学习材料,把它们送到我的kindle上,然后清理输出。
Purpose of the project
pdfebc的核心功能以及一个基本的cli在我启动时就已经完成了 这个小项目。因此,这里的主要目的不是提供功能, 但要以稳健的方式做到这一点,要有适当的文档、测试和持续的集成。 这也是编写程序业务逻辑的练习,以便 接口可以放在上面。这也是我第一次尝试使用 sphinx、Travis-CI和ReadTheDocs,所以这里肯定有一些奇怪的地方 在那里。我还深入研究了如何使用git并尝试新的东西,因此 历史可能会有一些不一致之处。
Requirements
除了requirements.txt中列出的python模块外,还必须满足以下要求 会议:
- Python3.6
- 严格地说,3.5也应该运行良好,但是测试使用3.6特性,所以 只测试3.6版本。
- Ghostscript
- pdfebc需要Ghostscript才能进行pdf压缩。默认二进制文件是gs, 但这可以通过cli指定。
- Gmail帐户(用于发送电子邮件)
- 默认情况下,pdfebc使用google的smtp服务器发送电子邮件。但是程序可以 通过管理config.cnf文件配置为使用任何SMTP服务器(请参见 这个sample configuration用于格式化)。目前,服务器必须支持TLS。
Install
Option 1: Install from PyPi with ^{tt1}$
最新版本的pdfebc-core在pypi上,因此可以像往常一样用pip安装。 我强烈建议在系统范围内pip安装(即sudo pip install <package>),如下所示 可能会在很短的时间内给您带来不兼容的软件包。按用户安装 可以这样做:
- 执行pip install --userpdfebc-core安装包。
- 目前,您必须手动添加配置文件。请看一下 sample configuration文件获取详细信息。配置文件的放置位置是 依赖于机器,由appdirs包决定。跑步 apdirs.user_config_dir('pdfebc')在python解释器中找到正确的目录。 请注意,您必须首先导入appdirs,才能使其在解释器中可用。 注意:使用Gmail帐户时,我强烈建议 使用App password而不是实际的帐户密码。
Option 2: Clone the repo and the install with ^{tt1}$
如果您需要开发版本,则需要克隆repo,因为只上载发行版本 给皮皮。除非你打算自己动手,否则我建议你使用发行版。
- 用git: 克隆repo
- git clone https://github.com/slarse/pdfebc-core
- cd进入项目根目录并用pip安装。
- pip install --user .,这将为当前用户创建本地安装。
- 或者只要pip install .如果你使用virtualenv。
- 对于development,在virtualenv中使用pip install -e .。
- 目前,您必须手动添加配置文件。请看一下 sample configuration文件获取详细信息。配置文件的放置位置是 依赖于机器,由appdirs包决定。跑步 apdirs.user_config_dir('pdfebc')在python解释器中找到正确的目录。 请注意,您必须首先导入appdirs,才能使其在解释器中可用。 注意:使用Gmail帐户时,我强烈建议 使用App password而不是实际的帐户密码。
License
这个软件是根据麻省理工学院的许可证授权的。有关详细信息,请参见license file文件。
Contributing
我现在不需要捐款。在这一点上,这是我的一个实践项目, 即使我在寻找外部帮助,测试套件也远远不够全面 为了这个。对不起的!