Skip to main content

Booknot

continuous_integration

Booknot 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 using sphinx engine.

Getting started

pip install booknot

Usage

  1. start your booknot project in an empty directory or in an existing sphinx workspace
booknot init
  1. capture an existing page
booknot capture https://www.youtube.com/watch?v=q9T4tl1tmAY

The latest version

You can find the latest version to ...

git clone https://github.com/FabienArcellier/booknot.git

Developper guideline

Add a dependency

Write the dependency in setup.py. As it's the distribution standard for pypi, I prefer to keep setup.py as single source of truth.

I encourage avoiding using instruction as pipenv install requests to register a new library. You would have to write your dependency in both setup.py and Pipfile.

Install development environment

Use make to instanciate a python virtual environment in ./venv and install the python dependencies.

make install_requirements_dev

Update release dependencies

Use make to instanciate a python virtual environment in ./venv and freeze dependencies version on requirement.txt.

make update_requirements

Activate the python environment

When you setup the requirements, a venv directory on python 3 is created. To activate the venv, you have to execute :

make venv
source venv/bin/activate

Run the linter and the unit tests

Before commit or send a pull request, you have to execute pylint to check the syntax of your code and run the unit tests to validate the behavior.

make lint
make tests

Contributors

  • Fabien Arcellier

License

MIT License

Copyright (c) 2018 Fabien Arcellier

Permission 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.

Metadata

Release files for booknot 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for booknot 0.0.3
File Size Uploaded Provenance Actions
booknot-0.0.3.tar.gz 7.5 kB Without provenance Details for booknot-0.0.3.tar.gz

Release files / booknot-0.0.3.tar.gz

Download URL booknot-0.0.3.tar.gz
Size 7.5 kB
Tags Source
SHA-256 checksum
How to use checksums
6793fdbf4f010e2c6fdf2c562ef6894323315efcd48a34490634af1bc5fa939f
BLAKE2b-256 checksum
How to use checksums
8839a7cb5e492b51b6b27c948382b59b6eeb2052d8ed2d382387f814d1858f59
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.9

Security for booknot 0.0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page