Metadata-Version: 2.1
Name: booknot
Version: 0.0.1
Summary: UNKNOWN
Home-page: UNKNOWN
License: MIT license
Description: ## Booknot
        
        ![Build status](https://github.com/FabienArcellier/booknot/workflows/continuous_integration/badge.svg)
        
        **This tool does not work yet**.
        
        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
        
        ```bash
        pip install booknot
        ```
        
        ## Usage
        
        1. start your booknot project
        
        ```bash
        booknot init
        ```
        
        1. capture an existing page
        
        ```bash
        booknot capture https://www.youtube.com/watch?v=q9T4tl1tmAY
        ```
        
        ## The latest version
        
        You can find the latest version to ...
        
        ```bash
        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.
        
        ```bash
        make install_requirements_dev
        ```
        
        ### Update release dependencies
        
        Use make to instanciate a python virtual environment in ./venv and freeze
        dependencies version on requirement.txt.
        
        ```bash
        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 :
        
        ```bash
        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.
        
        ```bash
        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.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Description-Content-Type: text/markdown
Provides-Extra: dev
