Skip to main content

openbases python helper functions for https://openbases.github.io

Project description

OpenBases Python

PyPI version CircleCI

docs/img/logo-small.png


This is a small module with helper functions and scripts for using Open Bases tools. Please contribute at openbases/openbases-python on Github. Documentation is here

Just... no!

docs/img/before.png

Better!

docs/img/upgrade.png

Quick Start

To install

git clone https://www.github.com/openbases/openbases-python
cd openbases-python
python setup.py install
pip install openbases

There are different console entry points depending on the kind of functions that you need.

Open Bases Icons

Get an icon from openbases-icons

$ ob-icons
https://openbases.github.io/openbases-icons/flaticon/sea-life-collection/squid.svg
$ ob-icons --help

Open Bases Icons [v0.0.1]

usage: ob-icons [--version] [--regexp REGEXP] [--help] [--url URL] [--n N]
                [--sep SEP]

OpenBases Python Icons

optional arguments:
  --version        show openbases python version
  --regexp REGEXP  regular expression filter for icon name
  --help           show openbases icons help
  --url URL        complete url for json list of icons
  --n N, --N N     number of icons to return
  --sep SEP        separator to print icons to screen (default newline)

icons usage

Open Base Badges

Generate badges and strings of badges with the ob-badge entrypoint

$ ob-badge 

Open Bases Badges Python [v0.0.3]

usage: ob-badge [-h] [--version] general usage ...

OpenBases Python Badges

optional arguments:
  -h, --help     show this help message and exit
  --version      show openbases python version

actions:
  actions for openbases

  general usage  description
    view         view options for style, labels, etc.
    create       extract values from a paper.md
$ ob-badge create experiment labjs
![https://img.shields.io/badge/experiment-labjs-%23eaab1b.svg?style=flat&link=https%3A%2F%2Fopenbases.github.io](https://img.shields.io/badge/experiment-labjs-%23eaab1b.svg?style=flat&link=https%3A%2F%2Fopenbases.github.io)

https://img.shields.io/badge/experiment-labjs-%23eaab1b.svg?style=flat&link=https%3A%2F%2Fopenbases.github.io

badges usage

Open Bases Paper

ob-paper is the console entry point for interacting with a paper, typically a paper.md.

$ ob-paper help

Open Bases Paper Python [v0.0.0]

usage: ob-paper [--debug] [--quiet] [--version] general usage ...

OpenBases Python Paper

optional arguments:
  --debug, -d    use verbose logging to debug.
  --quiet, -q    suppress all normal output
  --version      show openbases python version

actions:
  actions for openbases

  general usage  description
    get          extract values from a paper.md
    shell        start an interactive shell with openbases paper

For complete usage, please see:

Have fun!

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 openbases, version 0.0.55
Filename, size File type Python version Upload date Hashes
Filename, size openbases-0.0.55.tar.gz (46.5 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