未提供项目说明
booknot的Python项目详细描述
书呆子
Booknot帮助你记录网页、youtube上的视频或互联网上的pdf文件。它会创造
使用sphinx引擎编写注释和反射的现成空间。在
入门
pip install booknot
使用
您应该从以下配置之一开始：
- 从头开始
- 从现有的sphinx工作区开始
从头开始
1。在空目录中启动booknot项目
booknot init将建议您创建一个sphinx工作区。在
2。捕获现有页面
booknot capture https://www.youtube.com/watch?v=q9T4tl1tmAY
从现有的sphinx工作区开始
除了booknot之外的相同工作流不会建议创建sphinx工作区。这种模式 允许在sphinx工作区中有多个booknote。在
# create a sphinx workspace by hand sphinx-quickstart -p multibooknot -a me . mkdir topic1 cd topic1 booknot init cd .. mkdir topic2 cd topic2 booknot init
最新版本
你可以找到最新版本。。。在
git clone https://github.com/FabienArcellier/booknot.git
开发人员指南
添加依赖项
将依赖项写入setup.py。因为这是pypi的分布标准，
我宁愿把setup.py作为唯一的真理来源。在
我鼓励避免使用指令作为pipenv install requests来注册
新图书馆。您必须同时在setup.py和Pipfile中编写依赖关系。在
安装开发环境
使用make在./venv中实例化python虚拟环境并安装 python依赖关系。在
make install_requirements_dev
更新版本依赖项
使用make在./venv中实例化python虚拟环境并冻结 上的依赖项版本要求.txt. 在
make update_requirements
激活python环境
当您设置需求时，将在python3上创建一个venv目录。
要激活venv，必须执行：
make venv
source venv/bin/activate
运行linter和单元测试
在提交或发送pull请求之前，您必须执行pylint来检查语法
并运行单元测试来验证行为。在
make lint make tests
贡献者
- 费比安·阿切利埃
许可证
麻省理工学院执照
版权所有（c）2018 Fabien Arcellier
兹免费准许任何人取得复制品 本软件及其相关文档文件（“软件”）的 在软件中不受限制，包括但不限于权利 使用、复制、修改、合并、发布、分发、再授权和/或出售 软件的副本，并允许软件的使用者 根据以下条件提供：
上述版权声明和本许可声明应包括在所有 软件的副本或大部分。在
本软件按“原样”提供，无任何形式的保证，明示或 包括但不限于适销性保证， 特定目的的适用性和非侵犯性。在任何情况下 作者或版权持有人应对任何索赔、损害赔偿或其他 无论是在合同诉讼、侵权诉讼或其他诉讼中，由以下原因引起的责任：， 与软件、软件的使用或其他交易有关 软件。在
- 项目
标签：
欢迎加入QQ群-->： 979659372
