# Solun-CLI
Solun-CLI is a command line interface tool for uploading files to Solun.
## Installation
Clone the repository and navigate to the project directory:
```bash
cd cli
pip install .
```
## Usage
The `solun` command can be used to upload files with optional settings for brute force protection, password, end-to-end encryption, and auto deletion.
### Basic Upload
Upload a file:
```bash
solun file -p /path/to/your/file
```
### Advanced Upload
Upload a file with brute force protection, a password, end-to-end encryption, and set an auto deletion parameter:
```bash
solun file -p /path/to/your/file -b -pw "YourPassword" -e2e -ad 1d
```
## Arguments
* -p, --path: Path to the file to be uploaded.
* -b, --bruteforceSafe: Enable brute force protection (default: disabled).
* -pw, --password: Set a password for the file (default: None).
* -e2e, --endToEndEncryption: Enable end-to-end encryption (default: disabled).
* -ad, --autoDeletion: Set auto deletion parameter. Options: download, 1d, 1w, 1m, 3m, 6m, 1y, never (default: download).
## Build and Publish
To build the package, first install the build tool with:
```bash
pip install build
```
Then run the following command in the root directory of the project:
```bash
python3 -m build
```
This will generate distribution files in the dist directory that you can publish to PyPI.
Before publishing the package, ensure any previous build artifacts are cleared to avoid errors:
```bash
rm -rf solun.egg-info
```
To publish the package to PyPI, use the following twine command (make sure twine is installed using pip install twine):
```bash
twine upload dist/*
```
Raw data
{
"_id": null,
"home_page": "https://solun.pm/",
"name": "solun",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "CLI,file-upload,solun,solun-cli,solun-pm",
"author": "Daniel Wagner",
"author_email": "contact@solun.pm",
"download_url": "https://files.pythonhosted.org/packages/3f/5a/bc9cfc93167c470713e9f13fa15b9fbbe43ac2eec21d97b5a972ef166290/solun-0.0.5.tar.gz",
"platform": null,
"description": "# Solun-CLI\n\nSolun-CLI is a command line interface tool for uploading files to Solun.\n\n## Installation\n\nClone the repository and navigate to the project directory:\n\n```bash\ncd cli\npip install .\n```\n\n## Usage\nThe `solun` command can be used to upload files with optional settings for brute force protection, password, end-to-end encryption, and auto deletion.\n\n### Basic Upload\nUpload a file:\n\n```bash\nsolun file -p /path/to/your/file\n```\n\n### Advanced Upload\nUpload a file with brute force protection, a password, end-to-end encryption, and set an auto deletion parameter:\n\n```bash\nsolun file -p /path/to/your/file -b -pw \"YourPassword\" -e2e -ad 1d\n```\n\n## Arguments\n* -p, --path: Path to the file to be uploaded.\n* -b, --bruteforceSafe: Enable brute force protection (default: disabled).\n* -pw, --password: Set a password for the file (default: None).\n* -e2e, --endToEndEncryption: Enable end-to-end encryption (default: disabled).\n* -ad, --autoDeletion: Set auto deletion parameter. Options: download, 1d, 1w, 1m, 3m, 6m, 1y, never (default: download).\n\n## Build and Publish\n\nTo build the package, first install the build tool with:\n\n```bash\npip install build\n```\n\nThen run the following command in the root directory of the project:\n\n```bash\npython3 -m build\n```\n\nThis will generate distribution files in the dist directory that you can publish to PyPI.\nBefore publishing the package, ensure any previous build artifacts are cleared to avoid errors:\n\n```bash\nrm -rf solun.egg-info\n```\n\nTo publish the package to PyPI, use the following twine command (make sure twine is installed using pip install twine):\n```bash\ntwine upload dist/*\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Solun-CLI is a command line interface tool for uploading files to Solun.",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://solun.pm/"
},
"split_keywords": [
"cli",
"file-upload",
"solun",
"solun-cli",
"solun-pm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5d314c8a4c95d168a623c9e500deef7a5dac8d7625697f946bf978ead973527",
"md5": "47b68d426007cfa9451f3184009f635c",
"sha256": "01361c5ab3e0acbf6ea76686804d5e4f4467c0d9118b9691a2d3e32f403b1b25"
},
"downloads": -1,
"filename": "solun-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "47b68d426007cfa9451f3184009f635c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4981,
"upload_time": "2023-11-24T00:08:05",
"upload_time_iso_8601": "2023-11-24T00:08:05.529086Z",
"url": "https://files.pythonhosted.org/packages/e5/d3/14c8a4c95d168a623c9e500deef7a5dac8d7625697f946bf978ead973527/solun-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3f5abc9cfc93167c470713e9f13fa15b9fbbe43ac2eec21d97b5a972ef166290",
"md5": "d172758889fc0e06032ab503a676a793",
"sha256": "e4afc762566864882eebb85e1631eda2faa6f44d88eb48a43ae6d7f2f7cbfe1e"
},
"downloads": -1,
"filename": "solun-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "d172758889fc0e06032ab503a676a793",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4451,
"upload_time": "2023-11-24T00:08:07",
"upload_time_iso_8601": "2023-11-24T00:08:07.158930Z",
"url": "https://files.pythonhosted.org/packages/3f/5a/bc9cfc93167c470713e9f13fa15b9fbbe43ac2eec21d97b5a972ef166290/solun-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-24 00:08:07",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "solun"
}
JSON