openbases python helper functions for https://openbases.github.io
Project description
# OpenBases Python
[![PyPI version](https://badge.fury.io/py/openbases.svg)](https://badge.fury.io/py/openbases)
[![CircleCI](https://circleci.com/gh/openbases/openbases-python.svg?style=svg)](https://circleci.com/gh/openbases/openbases-python)
![docs/img/logo-small.png](https://github.com/openbases/openbases-python/raw/master/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](https://www.github.com/openbases/openbases-python) on
Github. Documentation is [here](https://openbases.github.io/openbases-python/html/usage.html)
> Just... no!
![docs/img/before.png](https://github.com/openbases/openbases-python/raw/master/docs/img/before.png)
> Better!
![docs/img/upgrade.png](https://github.com/openbases/openbases-python/raw/master/docs/img/upgrade.png)
# 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)
```
## 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!
[![PyPI version](https://badge.fury.io/py/openbases.svg)](https://badge.fury.io/py/openbases)
[![CircleCI](https://circleci.com/gh/openbases/openbases-python.svg?style=svg)](https://circleci.com/gh/openbases/openbases-python)
![docs/img/logo-small.png](https://github.com/openbases/openbases-python/raw/master/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](https://www.github.com/openbases/openbases-python) on
Github. Documentation is [here](https://openbases.github.io/openbases-python/html/usage.html)
> Just... no!
![docs/img/before.png](https://github.com/openbases/openbases-python/raw/master/docs/img/before.png)
> Better!
![docs/img/upgrade.png](https://github.com/openbases/openbases-python/raw/master/docs/img/upgrade.png)
# 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)
```
## 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!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
openbases-0.0.2.tar.gz
(915.5 kB
view details)
File details
Details for the file openbases-0.0.2.tar.gz
.
File metadata
- Download URL: openbases-0.0.2.tar.gz
- Upload date:
- Size: 915.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8da36f1d5f9094985a80e7a05b6b2ad241e87c9d85cda5d2f1d4a5304b8d7993 |
|
MD5 | 2ed3584aab85964e246890f0e39169ac |
|
BLAKE2b-256 | 446bfbe875ded2c4e661cf8a86ae303420531cd6036d85c79ddf6b33c6798ea6 |