# Synophotos - Synology Photos Command Line Interface
[](https://synophotos.readthedocs.io/en/latest/?badge=latest)
Synophotos Command Line Interface (CLI) is an attempt to enable remote control of certain functions in Synology Photos from a terminal.
## Features
- connect to a Synology Photos instance and run various commands remotely
- list and count albums, folders and images
- list users and groups
- create albums and populate albums from existing items
- share and unshare albums
## Quickstart
Use pip to create and activate a virtual environment and install synophotos:
```bash
> mkdir synophotos
> pip -m venv synophotos
> source synophotos/bin/activate
> pip install synophotos
```
Initialize the application:
```bash
> synophotos init
A sample configuration file has been created in "$USER_CONFIG/synophotos/"
```
Edit the file `config.yaml` found in `$USER_CONFIG/synophotos/` and insert your server URL and credentials.
Run synophotos to check what albums you have:
```bash
> synophotos albums
id │ name │ item_count │ owner_user_id │ shared
╶────┼───────────────┼────────────┼───────────────┼────────╴
2 │ 'My Birthday' │ 31 │ 2 │ True
1 │ 'Private' │ 10 │ 2 │ False
```
## Installation, Getting Started and Command Reference
The complete documentation is hosted at readthedocs.io: [http://synophotos.readthedocs.io/](http://synophotos.readthedocs.io/).
## Related Projects
- Synology API Wrapper (https://github.com/N4S4/synology-api)
- Unofficial Synology Photos API Documentation (https://github.com/zeichensatz/SynologyPhotosAPI)
Raw data
{
"_id": null,
"home_page": null,
"name": "synophotos",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "fortysix2ahead <fortysix2ahead@gmail.com>",
"keywords": "synology,photos,terminal,cli,command line",
"author": null,
"author_email": "fortysix2ahead <fortysix2ahead@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/c2/85/3d7279b7050fc12048f147f0c70312b7d594cbf9f859559d3daa9677e91c/synophotos-0.2.3.tar.gz",
"platform": null,
"description": "\n# Synophotos - Synology Photos Command Line Interface\n\n[](https://synophotos.readthedocs.io/en/latest/?badge=latest)\n\nSynophotos Command Line Interface (CLI) is an attempt to enable remote control of certain functions in Synology Photos from a terminal.\n\n## Features\n\n- connect to a Synology Photos instance and run various commands remotely \n- list and count albums, folders and images\n- list users and groups\n- create albums and populate albums from existing items\n- share and unshare albums\n\n## Quickstart\n\nUse pip to create and activate a virtual environment and install synophotos:\n\n```bash\n> mkdir synophotos\n> pip -m venv synophotos\n> source synophotos/bin/activate\n> pip install synophotos\n```\n\nInitialize the application:\n\n```bash\n> synophotos init\nA sample configuration file has been created in \"$USER_CONFIG/synophotos/\"\n```\n\nEdit the file `config.yaml` found in `$USER_CONFIG/synophotos/` and insert your server URL and credentials.\n\nRun synophotos to check what albums you have:\n\n```bash\n> synophotos albums\n\n id \u2502 name \u2502 item_count \u2502 owner_user_id \u2502 shared\n\u2576\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2574\n 2 \u2502 'My Birthday' \u2502 31 \u2502 2 \u2502 True\n 1 \u2502 'Private' \u2502 10 \u2502 2 \u2502 False\n```\n\n## Installation, Getting Started and Command Reference\n\nThe complete documentation is hosted at readthedocs.io: [http://synophotos.readthedocs.io/](http://synophotos.readthedocs.io/).\n\n## Related Projects\n\n- Synology API Wrapper (https://github.com/N4S4/synology-api)\n- Unofficial Synology Photos API Documentation (https://github.com/zeichensatz/SynologyPhotosAPI)\n",
"bugtrack_url": null,
"license": null,
"summary": "Command Line Interface Client for Synology Photos",
"version": "0.2.3",
"project_urls": {
"Documentation": "https://synophotos.readthedocs.io/",
"Homepage": "https://github.com/fortysix2ahead/synophotos/",
"Issue Tracker": "https://github.com/fortysix2ahead/synophotos/issues/",
"Source": "https://github.com/fortysix2ahead/synophotos/",
"Source Code": "https://github.com/fortysix2ahead/synophotos/"
},
"split_keywords": [
"synology",
"photos",
"terminal",
"cli",
"command line"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b196503c4970b9cac5ccbc55767be84d85e1ebc2972bfe671c7b8d8170d91780",
"md5": "a6f22dde9e044d8ff44f4eb66fa43ba6",
"sha256": "9610d12f7440ff36ad89bb7818c4a009f47a69dfbd6c9d00831cdb955cd8170a"
},
"downloads": -1,
"filename": "synophotos-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a6f22dde9e044d8ff44f4eb66fa43ba6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 25455,
"upload_time": "2023-11-21T09:20:15",
"upload_time_iso_8601": "2023-11-21T09:20:15.224631Z",
"url": "https://files.pythonhosted.org/packages/b1/96/503c4970b9cac5ccbc55767be84d85e1ebc2972bfe671c7b8d8170d91780/synophotos-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c2853d7279b7050fc12048f147f0c70312b7d594cbf9f859559d3daa9677e91c",
"md5": "756076c6a0a4061ac88c0c9f858b89ad",
"sha256": "40b1515781a7b4d938ac307d8d7e30dc13bfa954490d0c9994683713c8e47e9a"
},
"downloads": -1,
"filename": "synophotos-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "756076c6a0a4061ac88c0c9f858b89ad",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 31424,
"upload_time": "2023-11-21T09:20:17",
"upload_time_iso_8601": "2023-11-21T09:20:17.569729Z",
"url": "https://files.pythonhosted.org/packages/c2/85/3d7279b7050fc12048f147f0c70312b7d594cbf9f859559d3daa9677e91c/synophotos-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-21 09:20:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fortysix2ahead",
"github_project": "synophotos",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "synophotos"
}
JSON
