clipthread-server


Nameclipthread-server JSON
Version 0.0.2 PyPI version JSON
download
home_pageNone
SummaryA clipboard synchronization tool that work on every platform
upload_time2025-01-15 20:12:09
maintainerNone
docs_urlNone
authorNone
requires_python>=3.09
licenseNone
keywords clipboard clipthread server sync synchronization
VCS
bugtrack_url
requirements FastAPI uvicorn pydantic sqlite3 python-dotenv
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ClipThread Server

ClipThread is a multi-platform clipboard synchronization tool that enables real-time sharing of clipboard content across different devices. It uses a client-server architecture to maintain clipboard history and ensure secure synchronization between multiple devices.

## Purpose
The ClipThread server acts as the central hub for all clipboard operations. It:
- Manages clipboard content synchronization between connected clients 
- Maintains a clipboard history journal
- Handles secure data transmission between devices
- Provides REST API endpoints for clipboard operations

## Running the Server

### Using Docker Compose
```bash
# Clone the repository
git clone https://github.com/clipthread/clipthread-server.git

# Navigate to docker directory
cd clipthread-server/docker

# Start the server
docker-compose up -d
```

### Using Systemd
1. Install the package:
```bash
pip install clipthread-server
```

2. Copy the systemd service file:
```bash
sudo cp systemd/clipthread-server.service /etc/systemd/system/
```

3. Start the service:
```bash
sudo systemctl enable clipthread-server
sudo systemctl start clipthread-server
```

## License
This project is licensed under the MIT License - see the LICENSE file for details.

## Todo
- [ ] Add authentication system
- [ ] Implement encryption for clipboard content
- [ ] Create API documentation
- [ ] Add rate limiting
- [ ] Implement clipboard content filtering

## Client Applications
- Desktop UI (Tkinter): [ui-tkinter](https://github.com/clipthread/ui-tkinter)
- Core Library: [clipthread-core](https://github.com/clipthread/core)
- Android App: [clipthread-android](https://github.com/clipthread/android)
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "clipthread-server",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.09",
    "maintainer_email": null,
    "keywords": "clipboard, clipthread, server, sync, synchronization",
    "author": null,
    "author_email": "Leo Cances <leocances@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/b3/01/7b7dc1204f3a47ba6b331ec309ead4134a16831efca2971ccd8877cd7758/clipthread_server-0.0.2.tar.gz",
    "platform": null,
    "description": "# ClipThread Server\n\nClipThread is a multi-platform clipboard synchronization tool that enables real-time sharing of clipboard content across different devices. It uses a client-server architecture to maintain clipboard history and ensure secure synchronization between multiple devices.\n\n## Purpose\nThe ClipThread server acts as the central hub for all clipboard operations. It:\n- Manages clipboard content synchronization between connected clients \n- Maintains a clipboard history journal\n- Handles secure data transmission between devices\n- Provides REST API endpoints for clipboard operations\n\n## Running the Server\n\n### Using Docker Compose\n```bash\n# Clone the repository\ngit clone https://github.com/clipthread/clipthread-server.git\n\n# Navigate to docker directory\ncd clipthread-server/docker\n\n# Start the server\ndocker-compose up -d\n```\n\n### Using Systemd\n1. Install the package:\n```bash\npip install clipthread-server\n```\n\n2. Copy the systemd service file:\n```bash\nsudo cp systemd/clipthread-server.service /etc/systemd/system/\n```\n\n3. Start the service:\n```bash\nsudo systemctl enable clipthread-server\nsudo systemctl start clipthread-server\n```\n\n## License\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## Todo\n- [ ] Add authentication system\n- [ ] Implement encryption for clipboard content\n- [ ] Create API documentation\n- [ ] Add rate limiting\n- [ ] Implement clipboard content filtering\n\n## Client Applications\n- Desktop UI (Tkinter): [ui-tkinter](https://github.com/clipthread/ui-tkinter)\n- Core Library: [clipthread-core](https://github.com/clipthread/core)\n- Android App: [clipthread-android](https://github.com/clipthread/android)",
    "bugtrack_url": null,
    "license": null,
    "summary": "A clipboard synchronization tool that work on every platform",
    "version": "0.0.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/clipthread/clipthread-server/issues",
        "Documentation": "https://github.com/clipthread/clipthread-server#readme",
        "Homepage": "https://github.com/clipthread/clipthread-server.git",
        "Repository": "https://github.com/clipthread/clipthrea-serverd.git"
    },
    "split_keywords": [
        "clipboard",
        " clipthread",
        " server",
        " sync",
        " synchronization"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "47c1d1a96274611eca1dd490de0871b84f56201bc47a11023b569f2ae6393c2d",
                "md5": "0d5fb3432aee3b252fbc26b96b6f2f68",
                "sha256": "5d2d056b946d3ccb724d4cb45b79b859f9d4a77932a831838750c2c149581526"
            },
            "downloads": -1,
            "filename": "clipthread_server-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0d5fb3432aee3b252fbc26b96b6f2f68",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.09",
            "size": 10146,
            "upload_time": "2025-01-15T20:12:01",
            "upload_time_iso_8601": "2025-01-15T20:12:01.887476Z",
            "url": "https://files.pythonhosted.org/packages/47/c1/d1a96274611eca1dd490de0871b84f56201bc47a11023b569f2ae6393c2d/clipthread_server-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b3017b7dc1204f3a47ba6b331ec309ead4134a16831efca2971ccd8877cd7758",
                "md5": "d4228b14bd9dc3c8e3a30aeae90b55a4",
                "sha256": "c402fe9b2f4ae75a00862278bd56d234e62f1cb948350986a58681e365092d48"
            },
            "downloads": -1,
            "filename": "clipthread_server-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "d4228b14bd9dc3c8e3a30aeae90b55a4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.09",
            "size": 11494,
            "upload_time": "2025-01-15T20:12:09",
            "upload_time_iso_8601": "2025-01-15T20:12:09.486696Z",
            "url": "https://files.pythonhosted.org/packages/b3/01/7b7dc1204f3a47ba6b331ec309ead4134a16831efca2971ccd8877cd7758/clipthread_server-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-15 20:12:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "clipthread",
    "github_project": "clipthread-server",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "FastAPI",
            "specs": []
        },
        {
            "name": "uvicorn",
            "specs": []
        },
        {
            "name": "pydantic",
            "specs": []
        },
        {
            "name": "sqlite3",
            "specs": []
        },
        {
            "name": "python-dotenv",
            "specs": []
        }
    ],
    "lcname": "clipthread-server"
}
        
Elapsed time: 1.03736s