Skip to content
Snippets Groups Projects
Commit 483a0a9d authored by selva's avatar selva
Browse files

Added bitia-cli docs info

parent 57c97a0e
No related branches found
No related tags found
No related merge requests found
Pipeline #3732 passed with stages
in 2 minutes and 30 seconds
This commit is part of merge request !4. Comments created here will be created in the context of that merge request.
# BiTIA Installation
BiTIA CLI is the Command Interface tool helpful in getting user inputs with commands and required files, directories etc.
This submits jobs to the server, which contains bitia-runner that works on the job and produce results
**To work with BiTIA, we need to install bitia-cli and submit jobs to the server**
## Installing bitia
Installing bitia is very simple, you only need to have [python-pip] installed in your system
BiTIA CLI is available on [PyPi] as [BiTIA].
### Ensure you have a working pip
As a first step, you should check that you have a working Python with pip
installed. This can be done by running the following commands and making
sure that the output looks similar.
``` bash
$ python --version
Python 3.N.N
$ pip --version
pip X.Y.Z from ... (python 3.N.N)
```
If that worked, congratulations! You have a working pip in your environment.
To Install **BiTIA** using pip:
```
$ python3 -m pip install bitia
```
[BiTIA]: https://pypi.org/project/bitia/
[Pypi]: https://pypi.org/
[install Python]: https://realpython.com/installing-python/
[python-pip]: https://pypi.org/project/pip/
\ No newline at end of file
# Working with BiTIA CLI
BiTIA has two commands to work on it:
- run
- submit
## run
```{eval-rst}
.. autofunction:: bitia.__main__.prepare_archive
```
### Bitia run can be employed in three ways;
#### Example 1 - Input as String
- to be filled
#### Example 2 - Input as pipeline file
- to be filled
#### Example 3- Input as a Path Directory
- to be filled
\ No newline at end of file
...@@ -28,19 +28,19 @@ Creates a zip file of the user input(pipeline) containing a unique hash and ship ...@@ -28,19 +28,19 @@ Creates a zip file of the user input(pipeline) containing a unique hash and ship
:hidden: true :hidden: true
:name: getting_started :name: getting_started
getting_started getting_started/Installation
developer getting_started/Working
``` ```
If you want to learn how to use BiTIA and installation, check out the following resources: If you want to learn how to use BiTIA and installation, check out the following resources:
- [Getting Started](getting_started.md) - [Installation](getting_started/Installation.md)
- [Working with BiTIA](getting_started/Working.md)
```{eval-rst} ```{eval-rst}
.. automodule:: bitia .. automodule:: bitia
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment