Package: booknot
BooknotBooknot helps you to take note about a webpage, a video on youtube or a pdf on the internet. It will create
a ready to use space to write note and reflexion usingsphinxengine.Getting startedpipinstallbooknotUsageYou should start from one of this configuration :start from scratchstart from existing sphinx workspacestart from scratch1 . start your booknot project in an empty directorybooknot initwill propose you to create a sphinx workspace.$ booknot init
[?] This will bootstrap a workspace for sphinx in this directory, do you want to continue ? (y/N): y

[?] What the name of this booknot: Booknot
[?] What the name of the author: me

1. to render the booknot, use : make html
2. to open the booknot after rendering, use a browser and open _build/html/index.html
3. to bookmark a page, use : booknot capture https://...2 . capture an existing pagebooknotcapturehttps://www.youtube.com/watch?v=q9T4tl1tmAYstart from existing sphinx workspacesame workflow except booknot won't proposed to create a sphinx workspace. This pattern
allow to have more than one booknote by sphinx workspace.# create a sphinx workspace by handsphinx-quickstart-pmultibooknot-ame.

mkdirtopic1cdtopic1
booknotinitcd..
mkdirtopic2cdtopic2
booknotinitThe latest versionYou can find the latest version to ...gitclonehttps://github.com/FabienArcellier/booknot.gitDevelopper guidelineAdd a dependencyWrite the dependency insetup.py. As it's the distribution standard for pypi,
I prefer to keepsetup.pyas single source of truth.I encourage avoiding using instruction aspipenv install requeststo register
a new library. You would have to write your dependency in bothsetup.pyandPipfile.Install development environmentUse make to instanciate a python virtual environment in ./venv and install the
python dependencies.makeinstall_requirements_devUpdate release dependenciesUse make to instanciate a python virtual environment in ./venv and freeze
dependencies version on requirement.txt.makeupdate_requirementsActivate the python environmentWhen you setup the requirements, avenvdirectory on python 3 is created.
To activate the venv, you have to execute :makevenvsourcevenv/bin/activateRun the linter and the unit testsBefore commit or send a pull request, you have to executepylintto check the syntax
of your code and run the unit tests to validate the behavior.makelint
maketestsContributorsFabien ArcellierLicenseMIT LicenseCopyright (c) 2018 Fabien ArcellierPermission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.