| Name | rara-tools JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | None |
| Summary | Tools to support Kata's work. |
| upload_time | 2025-01-14 14:55:29 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# RaRa Tools
**`rara-tools`** is a Python library containing various generic tools used by components of Kata.
---
## ✨ Features
- Elasticsearch index & document operations
- S3 file management operations
- Task reporting to Core API
---
## ⚡ Quick Start
Get started with `rara-tools` in just a few steps:
1. **Install the Package**
Ensure you're using Python 3.10 or above, then run:
```bash
pip install rara-tools
```
2. **Import and Use**
Example usage to download a folder from S3:
```python
from rara_tools.s3 import S3Files
s3 = S3Files(
url="your-s3-address",
access_key = "xxx",
secret_key = "yyy",
bucket = "my-sad-bucket"
)
s3.download("my-folder-in-s3")
```
---
## ⚙️ Installation Guide
Follow the steps below to install the `rara-tools` package, either via `pip` or locally.
---
### Installation via `pip`
<details><summary>Click to expand</summary>
1. **Set Up Your Python Environment**
Create or activate a Python environment using Python **3.10** or above.
2. **Install the Package**
Run the following command:
```bash
pip install rara-tools
```
</details>
---
### Local Installation
Follow these steps to install the `rara-tools` package locally:
<details><summary>Click to expand</summary>
1. **Clone the Repository**
Clone the repository and navigate into it:
```bash
git clone <repository-url>
cd <repository-directory>
```
2. **Set Up Python Environment**
Create or activate a Python environment using Python 3.10 or above. E.g:
```bash
conda create -n py310 python==3.10
conda activate py310
```
3. **Install Build Package**
Install the `build` package to enable local builds:
```bash
pip install build
```
4. **Build the Package**
Run the following command inside the repository:
```bash
python -m build
```
5. **Install the Package**
Install the built package locally:
```bash
pip install .
```
</details>
---
## 🚀 Testing Guide
Follow these steps to test the `rara-tools` package.
### How to Test
<details><summary>Click to expand</summary>
1. **Clone the Repository**
Clone the repository and navigate into it:
```bash
git clone <repository-url>
cd <repository-directory>
```
2. **Set Up Python Environment**
Create or activate a Python environment using Python 3.10 or above.
3. **Install Build Package**
Install the `build` package:
```bash
pip install build
```
4. **Build the Package**
Build the package inside the repository:
```bash
python -m build
```
5. **Install with Testing Dependencies**
Install the package along with its testing dependencies:
```bash
pip install .[testing]
```
6. **Run Tests**
Run the test suite from the repository root:
```bash
python -m pytest -v tests
```
---
</details>
Raw data
{
"_id": null,
"home_page": null,
"name": "rara-tools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/fa/65/8ded12d0f980ade70706fd94cc7233f92abefa0662f76503392e0f9b3936/rara_tools-0.0.3.tar.gz",
"platform": null,
"description": "# RaRa Tools\n\n\n\n\n\n**`rara-tools`** is a Python library containing various generic tools used by components of Kata.\n\n---\n\n## \u2728 Features \n\n- Elasticsearch index & document operations\n- S3 file management operations\n- Task reporting to Core API\n---\n\n## \u26a1 Quick Start \n\nGet started with `rara-tools` in just a few steps:\n\n1. **Install the Package** \n Ensure you're using Python 3.10 or above, then run: \n ```bash\n pip install rara-tools\n ```\n\n2. **Import and Use** \n Example usage to download a folder from S3: \n\n ```python\n from rara_tools.s3 import S3Files\n\n s3 = S3Files(\n url=\"your-s3-address\",\n access_key = \"xxx\",\n secret_key = \"yyy\",\n bucket = \"my-sad-bucket\"\n )\n\n s3.download(\"my-folder-in-s3\")\n ```\n\n---\n\n## \u2699\ufe0f Installation Guide\n\nFollow the steps below to install the `rara-tools` package, either via `pip` or locally.\n\n---\n\n### Installation via `pip`\n\n<details><summary>Click to expand</summary>\n\n1. **Set Up Your Python Environment** \n Create or activate a Python environment using Python **3.10** or above.\n\n2. **Install the Package** \n Run the following command: \n ```bash\n pip install rara-tools\n ```\n</details>\n\n---\n\n### Local Installation\n\nFollow these steps to install the `rara-tools` package locally: \n\n<details><summary>Click to expand</summary>\n\n1. **Clone the Repository** \n Clone the repository and navigate into it: \n ```bash\n git clone <repository-url>\n cd <repository-directory>\n ```\n\n2. **Set Up Python Environment** \n Create or activate a Python environment using Python 3.10 or above. E.g:\n ```bash\n conda create -n py310 python==3.10\n conda activate py310\n ```\n\n3. **Install Build Package** \n Install the `build` package to enable local builds: \n ```bash\n pip install build\n ```\n\n4. **Build the Package** \n Run the following command inside the repository: \n ```bash\n python -m build\n ```\n\n5. **Install the Package** \n Install the built package locally: \n ```bash\n pip install .\n ```\n\n</details>\n\n---\n\n## \ud83d\ude80 Testing Guide\n\nFollow these steps to test the `rara-tools` package.\n\n\n### How to Test\n\n<details><summary>Click to expand</summary>\n\n1. **Clone the Repository** \n Clone the repository and navigate into it: \n ```bash\n git clone <repository-url>\n cd <repository-directory>\n ```\n\n2. **Set Up Python Environment** \n Create or activate a Python environment using Python 3.10 or above.\n\n3. **Install Build Package** \n Install the `build` package: \n ```bash\n pip install build\n ```\n\n4. **Build the Package** \n Build the package inside the repository: \n ```bash\n python -m build\n ```\n\n5. **Install with Testing Dependencies** \n Install the package along with its testing dependencies: \n ```bash\n pip install .[testing]\n ```\n\n6. **Run Tests** \n Run the test suite from the repository root: \n ```bash\n python -m pytest -v tests\n ```\n\n---\n\n</details>\n",
"bugtrack_url": null,
"license": null,
"summary": "Tools to support Kata's work.",
"version": "0.0.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0559f4b6bcafaa643f488dc837b722b24222bdb87cf05f15e584fabd758980dd",
"md5": "99bc28247473d25d9a373b9583c5c323",
"sha256": "efe880c669eab0148ef213e69197179f4491f88ebb89f8f0406c13f7919b35cc"
},
"downloads": -1,
"filename": "rara_tools-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "99bc28247473d25d9a373b9583c5c323",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 19395,
"upload_time": "2025-01-14T14:55:28",
"upload_time_iso_8601": "2025-01-14T14:55:28.553971Z",
"url": "https://files.pythonhosted.org/packages/05/59/f4b6bcafaa643f488dc837b722b24222bdb87cf05f15e584fabd758980dd/rara_tools-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fa658ded12d0f980ade70706fd94cc7233f92abefa0662f76503392e0f9b3936",
"md5": "3e050132939a2bf51373808d2d3bea60",
"sha256": "4fc8caa6173377d83f131afe26e4fdd2a9cbce6257a44bf2b9f199501af7d5f9"
},
"downloads": -1,
"filename": "rara_tools-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "3e050132939a2bf51373808d2d3bea60",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 21712,
"upload_time": "2025-01-14T14:55:29",
"upload_time_iso_8601": "2025-01-14T14:55:29.632921Z",
"url": "https://files.pythonhosted.org/packages/fa/65/8ded12d0f980ade70706fd94cc7233f92abefa0662f76503392e0f9b3936/rara_tools-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-14 14:55:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "rara-tools"
}
