rtspwebviewer


Namertspwebviewer JSON
Version 0.1.3 PyPI version JSON
download
home_pagehttps://github.com/luiscarlosgph/rtspwebviewer
SummarySimple web viewer for RTSP streams.
upload_time2023-12-30 02:51:13
maintainer
docs_urlNone
authorLuis C. Garcia-Peraza Herrera
requires_python
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Description
-----------

Web server that displays an RTSP video stream. 

It is not a very efficient solution in terms of video transmission, but you will be able to see the video stream from all devices (Windows, Linux, Mac, iPhone, Android). 

Audio is not supported.

Use case
--------

You have a security camera that streams in [RTSP](https://en.wikipedia.org/wiki/Real_Time_Streaming_Protocol) (e.g. [Foscam](https://www.amazon.co.uk/Foscam-Wireless-Indoor-Security-Camera/dp/B07WHY74F1)) and want to make the video accessible via web.

Install with pip
----------------

```bash
$ pip install rtspwebviewer --user
```

Install from source
-------------------

```bash
$ git clone https://github.com/luiscarlosgph/rtspwebviewer.git
$ cd rtspwebviewer
$ python3 setup.py install
```

Run 
---

* Syntax:
  ```bash
  $ python -m rtspwebviewer.run -a <listening_ip_address> -p <port> -t <web_title> -w <password> -u <rtsp_address>
  ```
  You can specify up to four RTSP addresses, e.g. `-u <rtsp_address> <rtsp_address> <rtsp_address> <rtsp_address>`

* Example:
  ```bash
  $ python -m rtspwebviewer.run -a 0.0.0.0 -p 7654 -t 'RTSP Web Viewer' -w fancypassword -u 'rtsp://user:pass@127.0.0.1:8669/unicast'
  ```
  In this case, you should access [http://127.0.0.1:7654/fancypassword](http://127.0.0.1:7654/fancypassword) to see the website displaying the video stream. 
  
  The IP address `0.0.0.0` means that the web server will listen in all your network interfaces. 

  The password parameter is optional, if you do not specify one, you should access [http://127.0.0.1:7654](http://127.0.0.1:7654) to see the video.
  
 
Run Docker container
---------------------
If you do not have Docker installed, you have an install guide [here](https://github.com/luiscarlosgph/how-to/tree/main/docker).

1. Build Docker image:
   ```bash
   $ git clone https://github.com/luiscarlosgph/rtspwebviewer.git
   $ cd rtspwebviewer
   $ docker build -t rtspwebviewer docker
   ```

2. Deploy container:
   ```bash
   $ docker run -it --name rtspwebviewer --net=host --restart=always rtspwebviewer:latest python -m rtspwebviewer.run -a <listening_address> -p <listening_port> -t <web_title> -w <web_password> -u <rtsp_address> &
   ```
   Access the camera view in `http://<ip>:<port>/<web_password>`
   
   If you do not know what to put on `<listening_address>`, use `0.0.0.0` (i.e. listen in all network interfaces).
   
   A password is not necessary. 

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/luiscarlosgph/rtspwebviewer",
    "name": "rtspwebviewer",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Luis C. Garcia-Peraza Herrera",
    "author_email": "luiscarlos.gph@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/9d/00/dc7c35f46b2efb4457f23634199687457c2b645a64e31473270a25355b93/rtspwebviewer-0.1.3.tar.gz",
    "platform": null,
    "description": "Description\n-----------\n\nWeb server that displays an RTSP video stream. \n\nIt is not a very efficient solution in terms of video transmission, but you will be able to see the video stream from all devices (Windows, Linux, Mac, iPhone, Android). \n\nAudio is not supported.\n\nUse case\n--------\n\nYou have a security camera that streams in [RTSP](https://en.wikipedia.org/wiki/Real_Time_Streaming_Protocol) (e.g. [Foscam](https://www.amazon.co.uk/Foscam-Wireless-Indoor-Security-Camera/dp/B07WHY74F1)) and want to make the video accessible via web.\n\nInstall with pip\n----------------\n\n```bash\n$ pip install rtspwebviewer --user\n```\n\nInstall from source\n-------------------\n\n```bash\n$ git clone https://github.com/luiscarlosgph/rtspwebviewer.git\n$ cd rtspwebviewer\n$ python3 setup.py install\n```\n\nRun \n---\n\n* Syntax:\n  ```bash\n  $ python -m rtspwebviewer.run -a <listening_ip_address> -p <port> -t <web_title> -w <password> -u <rtsp_address>\n  ```\n  You can specify up to four RTSP addresses, e.g. `-u <rtsp_address> <rtsp_address> <rtsp_address> <rtsp_address>`\n\n* Example:\n  ```bash\n  $ python -m rtspwebviewer.run -a 0.0.0.0 -p 7654 -t 'RTSP Web Viewer' -w fancypassword -u 'rtsp://user:pass@127.0.0.1:8669/unicast'\n  ```\n  In this case, you should access [http://127.0.0.1:7654/fancypassword](http://127.0.0.1:7654/fancypassword) to see the website displaying the video stream. \n  \n  The IP address `0.0.0.0` means that the web server will listen in all your network interfaces. \n\n  The password parameter is optional, if you do not specify one, you should access [http://127.0.0.1:7654](http://127.0.0.1:7654) to see the video.\n  \n \nRun Docker container\n---------------------\nIf you do not have Docker installed, you have an install guide [here](https://github.com/luiscarlosgph/how-to/tree/main/docker).\n\n1. Build Docker image:\n   ```bash\n   $ git clone https://github.com/luiscarlosgph/rtspwebviewer.git\n   $ cd rtspwebviewer\n   $ docker build -t rtspwebviewer docker\n   ```\n\n2. Deploy container:\n   ```bash\n   $ docker run -it --name rtspwebviewer --net=host --restart=always rtspwebviewer:latest python -m rtspwebviewer.run -a <listening_address> -p <listening_port> -t <web_title> -w <web_password> -u <rtsp_address> &\n   ```\n   Access the camera view in `http://<ip>:<port>/<web_password>`\n   \n   If you do not know what to put on `<listening_address>`, use `0.0.0.0` (i.e. listen in all network interfaces).\n   \n   A password is not necessary. \n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Simple web viewer for RTSP streams.",
    "version": "0.1.3",
    "project_urls": {
        "Homepage": "https://github.com/luiscarlosgph/rtspwebviewer"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9d00dc7c35f46b2efb4457f23634199687457c2b645a64e31473270a25355b93",
                "md5": "dcd890ce1a7c8f5e6a2cb30d85823631",
                "sha256": "d9cb2d7ae4fcb084e62f94ea143e3676fe3fdcea5c813a16a3c3b8b1d6cf2d13"
            },
            "downloads": -1,
            "filename": "rtspwebviewer-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "dcd890ce1a7c8f5e6a2cb30d85823631",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 17725,
            "upload_time": "2023-12-30T02:51:13",
            "upload_time_iso_8601": "2023-12-30T02:51:13.653978Z",
            "url": "https://files.pythonhosted.org/packages/9d/00/dc7c35f46b2efb4457f23634199687457c2b645a64e31473270a25355b93/rtspwebviewer-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-30 02:51:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "luiscarlosgph",
    "github_project": "rtspwebviewer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "rtspwebviewer"
}
        
Elapsed time: 0.17649s