Metadata-Version: 2.1
Name: featurize_jupyterlab
Version: 0.0.19
Summary: A server extension for JupyterLab's featurize extension
Home-page: UNKNOWN
Author: 
License: UNKNOWN
Description: # featurize-jupyterlab
        
        A JupyterLab extension.
        
        ## Prerequisites
        
        * Python >= 3.7
        * Node.js >= 8
        
        It's recommended to use [nvm](https://github.com/nvm-sh/nvm) to manage your node and npm versions.
        
        ## Installation
        
        ```bash
        jupyter labextension install featurize-jupyterlab
        ```
        
        ## Development
        
        ### For the first time
        
        1. Clone this repo
        ```
        git clone git@github.com:louis-she/featurize-jupyterlab.git
        ```
        
        2. Create virtual environment
        ```
        cd featurize-jupyterlab
        python -m venv .venv
        source .venv/bin/activate
        ```
        
        3. Install Python dependencies
        ```
        brew install postgresql
        pip3 install -r requirements.txt
        ```
        
        4. Install frontend dependencies
        ```
        npm install
        ```
        
        5. Install Typescript
        ```
        npm install -g typescript
        ```
        
        6. Add jupyter extension
        ```
        pip3 install -e .
        ./.venv/bin/jupyter serverextension enable --py featurize_jupyterlab
        ./.venv/bin/jupyter labextension install . --no-build
        ```
        
        7. Add featurize extension
        ```
        pip3 install featurize-package
        ./.venv/bin/featurize_server package:add ftpkg.demo
        ```
        
        8. Start development file watching
        ```
        npm run dev
        ```
        
        ### For the regular time
        
        1. source .venv/bin/activate
        2. npm run dev
        
        ## Writing tests
        
        We use `pytest` to write the tests case. All tests goes in the `featurize_jupyterlab/tests` directory.
        
        Both the test file and method should be started by `test_`, using the following command to run all the tests,
        ```
        pytest featurize_jupyterlab/tests
        ```
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
