openbases 0.0.5

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

# OpenBases Python

[](https://badge.fury.io/py/openbases)
[](https://circleci.com/gh/openbases/openbases-python)


-------------------------------------------------------------------------------

This is a small module with helper functions and scripts for using Open Bases tools.
Please contribute at [openbases/openbases-python](https://www.github.com/openbases/openbases-python) on
Github. Documentation is [here](https://openbases.github.io/openbases-python/html/usage.html)


> Just... no!


> Better!


# Quick Start

To install

```bash
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](https://www.github.com/openbases/openbases-icons)

```bash
$ ob-icons
https://openbases.github.io/openbases-icons/flaticon/sea-life-collection/squid.svg
```
```bash
$ 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](https://openbases.github.io/openbases-python/html/usage.html#icons)

## Open Base Badges

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

```bash
$ 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
```

[badges usage](https://openbases.github.io/openbases-python/html/usage.html#badges)

## Open Bases Paper

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

```bash
$ 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:

- [usage documentation](https://openbases.github.io/openbases-python/html/usage.html)
- [documentation](https://openbases.github.io/openbases-python/)
- implementation in [openbases-pdf](https://www.github.com/openbases/openbases-pdf/) and [builder-pdf](https://www.github.com/openbases/builder-pdf/)

Have fun!