# Noah
Noah is a project management tool specifically designed for bioinformatics projects. It enables reproducible analysis of large datasets, making it effortless to share and collaborate with others.
[](https://badge.fury.io/py/noah-cli)
[](https://opensource.org/licenses/MIT)
# Features
- [x] A human-readable configuration file
- [x] Git integration
- [x] Guaranteed reproducibility and portability
- [ ] Managing data, containers, and workflows, all in one place
# Installation
The easiest way to install Noah is to use pip:
```bash
pip install noah-cli
```
# Quickstart
To get started with Noah, use the `noah init` command to create a new project:
```bash
noah init my_project # This will by default create a Git repository
cd my_project
```
To add a new dataset to your project, use the `noah add` command:
```bash
noah add SRP123456 # ENCSR123ABC, GSE123456, etc. are also supported
```
You can also add privately hosted datasets:
```bash
noah add me@some_host:path/to/my_dataset ftp://ftp.example.com/another_dataset
```
If you share your project with others, they can easily retrieve the datasets you added:
```bash
noah install
```
For more information, please refer to [examples](examples/README.md).
# License
This software is licensed under the MIT license. See [LICENSE](LICENSE) for more details.
Raw data
{
"_id": null,
"home_page": "https://github.com/raymond-u/noah-cli",
"name": "noah-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "bioinformatics,project management",
"author": "raymond-u",
"author_email": "36328498+raymond-u@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/b8/57/c3e3132c62cb2116cfe20cd4dadef058d1c818db87870cd7764d5a13e38d/noah_cli-0.2.0.tar.gz",
"platform": null,
"description": "# Noah\n\nNoah is a project management tool specifically designed for bioinformatics projects. It enables reproducible analysis of large datasets, making it effortless to share and collaborate with others.\n\n[](https://badge.fury.io/py/noah-cli)\n[](https://opensource.org/licenses/MIT)\n\n# Features\n\n- [x] A human-readable configuration file\n- [x] Git integration\n- [x] Guaranteed reproducibility and portability\n- [ ] Managing data, containers, and workflows, all in one place\n\n# Installation\n\nThe easiest way to install Noah is to use pip:\n\n```bash\npip install noah-cli\n```\n\n# Quickstart\n\nTo get started with Noah, use the `noah init` command to create a new project:\n\n```bash\nnoah init my_project # This will by default create a Git repository\ncd my_project\n```\n\nTo add a new dataset to your project, use the `noah add` command:\n\n```bash\nnoah add SRP123456 # ENCSR123ABC, GSE123456, etc. are also supported\n```\n\nYou can also add privately hosted datasets:\n\n```bash\nnoah add me@some_host:path/to/my_dataset ftp://ftp.example.com/another_dataset\n```\n\nIf you share your project with others, they can easily retrieve the datasets you added:\n\n```bash\nnoah install\n```\n\nFor more information, please refer to [examples](examples/README.md).\n\n# License\n\nThis software is licensed under the MIT license. See [LICENSE](LICENSE) for more details.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "a project management tool for reproducible, portable, and streamlined bioinformatics analysis",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/raymond-u/noah-cli",
"Repository": "https://github.com/raymond-u/noah-cli"
},
"split_keywords": [
"bioinformatics",
"project management"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6bba4c81af8f4614516679907b521c0afc8d5642f4bf18c4da5b1353c2d87f27",
"md5": "72f4e27d2ef814987d6a85c25f5ef7b8",
"sha256": "45af7fa80c3317fad61945e8d584dd79b6afa30090a4333b191cbc328abc999b"
},
"downloads": -1,
"filename": "noah_cli-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "72f4e27d2ef814987d6a85c25f5ef7b8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 29300,
"upload_time": "2023-08-28T14:27:36",
"upload_time_iso_8601": "2023-08-28T14:27:36.186440Z",
"url": "https://files.pythonhosted.org/packages/6b/ba/4c81af8f4614516679907b521c0afc8d5642f4bf18c4da5b1353c2d87f27/noah_cli-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b857c3e3132c62cb2116cfe20cd4dadef058d1c818db87870cd7764d5a13e38d",
"md5": "6236f136d56537593f6d982739d0be93",
"sha256": "8406a8e5e397cfb4b29e64d0b1c342c3069aed5ebde4ef604e32c24689331e4f"
},
"downloads": -1,
"filename": "noah_cli-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "6236f136d56537593f6d982739d0be93",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 19993,
"upload_time": "2023-08-28T14:27:38",
"upload_time_iso_8601": "2023-08-28T14:27:38.462262Z",
"url": "https://files.pythonhosted.org/packages/b8/57/c3e3132c62cb2116cfe20cd4dadef058d1c818db87870cd7764d5a13e38d/noah_cli-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-28 14:27:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "raymond-u",
"github_project": "noah-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "noah-cli"
}
JSON
