bitia


Namebitia JSON
Version 0.2.3 PyPI version JSON
download
home_page
SummaryBioInformatics Tool for Infrastructure Automation (BiTIA) CLI utility.
upload_time2023-03-10 08:26:46
maintainer
docs_urlNone
authorDilawar Singh
requires_python>=3.8,<4.0
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <link rel="stylesheet" type="text/css" href="https://raw.githack.com/Ganz1285/termynal/master/termynal.css" />

# BioInformatics Tool for Infrastructure Automation (BiTIA) CLI utility

This is the cli utility of the BiTIA project. The other component is
`bitia-runner`. Most users only need the cli client `bitia` to submit jobs.
Install it using `pip`.

```
python -m pip install bitia --user
python -m bitia --help
```

## Configuration

TODO: Order of searching configuration file.

### Unix like systems

1. `./bitia.toml`
2. `~/.bitia.toml`
3. `$HOME/.config/bitia.toml`
3. `/etc/bitia.toml`


### Windows

1. `bitia.toml`
2. `%APPDATA%\bitia.toml`
3. `%PROGRAMDATA%\bitia.toml`

## BiTIA runner

If you are self-hosting the BiTIA server, you need `bitia-runner` as well. See
the documents of `bitia-runner` for more details. TODO.



## EXAMPLES

1. Using samtools to view a fastq file with same name as provided in url 
 
NORMAL PIPELINE EXECUTION CODE         |  BITIA EXECUTION CODE
:-------------------------:|:-------------------------:
![](./docs/source/img/readme_example_1.gif)  |![](./docs/source/img/readme_example_1_bitia.gif)



2. Using samtools to view a fastq file with different file name as provided in url

NORMAL PIPELINE EXECUTION CODE         |  BITIA EXECUTION CODE
:-------------------------:|:-------------------------:
![](./docs/source/img/readme_example_2.gif)  |![](./docs/source/img/readme_example_2_bitia.gif)

3. Using Fastqc to do Quality check on a fastq file with same file name as provided

NORMAL PIPELINE EXECUTION CODE         |  BITIA EXECUTION CODE
:-------------------------:|:-------------------------:
![](./docs/source/img/readme_example_3.gif)  |![](./docs/source/img/readme_example_3_bitia.gif)



            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "bitia",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Dilawar Singh",
    "author_email": "dilawar@subcom.tech",
    "download_url": "",
    "platform": null,
    "description": "<link rel=\"stylesheet\" type=\"text/css\" href=\"https://raw.githack.com/Ganz1285/termynal/master/termynal.css\" />\n\n# BioInformatics Tool for Infrastructure Automation (BiTIA) CLI utility\n\nThis is the cli utility of the BiTIA project. The other component is\n`bitia-runner`. Most users only need the cli client `bitia` to submit jobs.\nInstall it using `pip`.\n\n```\npython -m pip install bitia --user\npython -m bitia --help\n```\n\n## Configuration\n\nTODO: Order of searching configuration file.\n\n### Unix like systems\n\n1. `./bitia.toml`\n2. `~/.bitia.toml`\n3. `$HOME/.config/bitia.toml`\n3. `/etc/bitia.toml`\n\n\n### Windows\n\n1. `bitia.toml`\n2. `%APPDATA%\\bitia.toml`\n3. `%PROGRAMDATA%\\bitia.toml`\n\n## BiTIA runner\n\nIf you are self-hosting the BiTIA server, you need `bitia-runner` as well. See\nthe documents of `bitia-runner` for more details. TODO.\n\n\n\n## EXAMPLES\n\n1. Using samtools to view a fastq file with same name as provided in url \n \nNORMAL PIPELINE EXECUTION CODE         |  BITIA EXECUTION CODE\n:-------------------------:|:-------------------------:\n![](./docs/source/img/readme_example_1.gif)  |![](./docs/source/img/readme_example_1_bitia.gif)\n\n\n\n2. Using samtools to view a fastq file with different file name as provided in url\n\nNORMAL PIPELINE EXECUTION CODE         |  BITIA EXECUTION CODE\n:-------------------------:|:-------------------------:\n![](./docs/source/img/readme_example_2.gif)  |![](./docs/source/img/readme_example_2_bitia.gif)\n\n3. Using Fastqc to do Quality check on a fastq file with same file name as provided\n\nNORMAL PIPELINE EXECUTION CODE         |  BITIA EXECUTION CODE\n:-------------------------:|:-------------------------:\n![](./docs/source/img/readme_example_3.gif)  |![](./docs/source/img/readme_example_3_bitia.gif)\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "BioInformatics Tool for Infrastructure Automation (BiTIA) CLI utility.",
    "version": "0.2.3",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c56b653ef2ea860f745f90b91c3323ef4de081f0308754f66e4c65383e243b3e",
                "md5": "37d32907a7a2240ee60edf777e9c22fc",
                "sha256": "827fa145c908401018855ac6c9882b3dfe02719aa7c60f74c430528a7ae0e518"
            },
            "downloads": -1,
            "filename": "bitia-0.2.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "37d32907a7a2240ee60edf777e9c22fc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 24055,
            "upload_time": "2023-03-10T08:26:46",
            "upload_time_iso_8601": "2023-03-10T08:26:46.760699Z",
            "url": "https://files.pythonhosted.org/packages/c5/6b/653ef2ea860f745f90b91c3323ef4de081f0308754f66e4c65383e243b3e/bitia-0.2.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-10 08:26:46",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "bitia"
}
        
Elapsed time: 0.13530s