docs/contents/30_usage.rst from boromir674/biskotaki

docs/contents/30_usage.rst

Summary

Maintainability

Test Coverage

Issues
Source
Stats

Issues

=====
Usage
=====

------------
Installation
------------

| **biskotaki** is available on PyPI hence you can use `pip` to install it.

It is recommended to perform the installation in an isolated `python virtual environment` (env).
You can create and activate an `env` using any tool of your preference (ie `virtualenv`, `venv`, `pyenv`).

Assuming you have 'activated' a `python virtual environment`:

.. code-block:: shell

  python -m pip install biskotaki


---------------
Simple Use Case
---------------

| Common Use Case for the biskotaki is to TODO Document

TODO Document