Skip to main content

cli tool to manage libivs modules

Project description

This is the npm + pip for libvis: it allows you to download, install and develop custom libvis modules.

Install libvis module

To download a module from libvis official repo https://github.com/libvis:

libvis-mods download gh:/libvis/<module name>
cd <module name>
libvis-mods install

Start your own module

Set up the project

To try out a simple module, you can start with a simple template that uses two files:

⟩ libvis-mods init-file MyModule
/home/dali/side-projects-hobby/pywebviz/mods/libvis_mods/project-templates/source-files {'name': 'MyModule'} .

⟩ cd MyModule/

~/MyModule ⟩ ls
MyModule-front.coffee  MyModule_back.py  readme.md

Original template repo: https://github.com/libvis/module-template-files

For a more complex project, use the init-dir command:

⟩ libvis-mods init-dir MyModule
/home/dali/side-projects-hobby/pywebviz/mods/libvis_mods/project-templates/source-dirs {'name': 'MyModule'} .

⟩ tree MyModule/
MyModule/
├── Makefile
├── README.md
├── back
│   ├── __init__.py
│   ├── main.py
│   └── utils.py
├── front
│   ├── index.js
│   ├── main.coffee
│   └── style.css
├── js_requirements.txt
├── libvis-mod.conf
└── py_requirements.txt

2 directories, 11 files

Original template repo: https://github.com/libvis/module-template-dirs

Develop with Hot-reload

cd MyModule
libvis-mods develop

This will start the react development server and a hot-reload server for the python module. The front and back will be reloaded on write. Use test variable on the web app to display the test_object from your module.

Commands

⟩ libvis-mods
Usage: libvis-mods [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  develop    Run the web server in development mode with hot reload
  download   Download source for the module into ./`module_name`
  init-dir
  init-file
  install    Install a module from directory
  list       list installed modules
  publish
  uninstall  Uninstall module
  where      Prints locations of where modules are installed

Requirements

Just yarn or npm to build the webapp.

Feedback

This project is under active development. Any feedback is welcome!

The mods repo is currently here https://github.com/DaniloZZZ/pywebviz.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for libvis-mods, version 0.1.12
Filename, size File type Python version Upload date Hashes
Filename, size libvis_mods-0.1.12-py3-none-any.whl (63.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size libvis_mods-0.1.12.tar.gz (45.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page