pybrowsers-profiles


Namepybrowsers-profiles JSON
Version 0.0.11 PyPI version JSON
download
home_pageNone
SummarySimple script for manage browser's profiles.
upload_time2024-04-22 15:22:23
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT License Copyright (c) 2023-present haaag <git.haaag@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords dmenu firefox librewolf profiles rofi
VCS
bugtrack_url
requirements pyselector
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">

![linux](https://img.shields.io/badge/os-linux-blue?logo=linux)
[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
![PyPI - Version](https://img.shields.io/pypi/v/pybrowsers-profiles)
[![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![code style - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/format.json)](https://github.com/astral-sh/ruff)
[![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/python/mypy)
[![License - MIT](https://img.shields.io/badge/license-MIT-9400d3.svg)](https://spdx.org/licenses/)

</div>

## Profile Launcher

### A Python Script for Effortless Browser Profile Management

### ⭐ About

This Python script simplifies launching browser profiles by automatically retrieving profile information from each browser's config directory. It presents these profiles as launch options, saving time and enhancing workflow, especially for users who frequently switch between multiple profiles.

### ⚡️ Requirements

- [dmenu](https://tools.suckless.org/dmenu/)
- [rofi](https://github.com/davatorium/rofi) _(Optional)_
- [fzf](https://github.com/junegunn/fzf) _(Optional)_

### 📦 Installation

#### Using `pipx` _(recommended)_

```bash
$ pipx install pybrowsers-profiles
```

> [pipx Homepage](https://github.com/pypa/pipx)

#### Using `pip` install

```bash
# Clone repository
$ git clone "https://github.com/haaag/PyBrowsers"
$ cd PyBrowsers-Profiles

# Create virtual environment & source
$ python -m venv .venv && source .venv/bin/activate

# Install
$ pip install .
```

### 🚀 Usage

```bash
$ pybrowsers --help

usage: pybrowsers [-l] [-d DISABLE] [-e ENABLE] [-f] [-t]
                  [-m MENU] [-v] [-V] [browser] [-o URL]

Simple script for manage browser's profiles

options:
    browser             Browser name
    -e, --enable        Enable browser
    -d, --disable       Disable browser
    -r, --running       Browser running and profile
    -u, --url           Open <URL> in browser
    -l, --list          Show browsers list and status
    -t, --table         Show browsers list with detail
    -m, --menu          Select menu (default: dmenu)
    -f, --found         Browsers found
    -V, --version       Show version
    -h, --help          Show help
    -v, --verbose       Verbose mode

locations:
    $HOME/.local/share/pybrowsers
```

#### Use `no flags` to launch menu

```bash
# Open menu with browsers found
$ pybrowsers
```

#### Use flag `browser` for browser's profile

```bash
# Open menu with profiles list
$ pybrowsers firefox
```

#### Use flag `-o, --open` for launching profile with url

<div align="left">
  <img align="center" src="assets/flag-open-with-browser.png">
</div>

#### Use flag `-m, --menu` to specify the launcher you want to use _(default: `dmenu`)_

<div align="left">
  <img align="center" src="assets/flag-rofi-dark.gif">
</div>

#### Use flag `-l, --list` for status

<div align="left">
  <img align="center" src="assets/flag-list.png">
</div>
<br>

#### Use flag `-d, --disable` or `-e, --enable`

```bash
# Disable browser (won't appear in `browsers found`)
$ pybrowsers -d firefox

# Enable browser
$ pybrowsers -e firefox
```

#### Use flag `-r, --running`

This flag will show all running browsers and profiles, as long as it has been
opened with `pybrowsers`

```bash
$ pybrowsers -r --url <URL>
```

### ➕ Add Browser

You can add a browser creating a `JSON` file in `$XDG_DATA_HOME/pybrowsers/` or
`~/.local/share/pybrowsers`

#### Example

```json
{
  "name": "LibreWolf",
  "command": "librewolf",
  "path": "~/.librewolf/profiles.ini",
  "engine": "gecko",
  "enabled": true
}
```

### 🌐 Browsers

- [Firefox](https://www.mozilla.org/firefox/download/thanks/)
- [LibreWolf](https://librewolf.net/)
- [Chromium](https://www.chromium.org/getting-involved/download-chromium/)
- Brave
- Google Chrome

### 🧰 Dependencies

- [PySelector](https://pypi.org/project/pyselector/)

### 🧰 TODO

- [ ] Create `interactive menu` for adding browser data
- [x] Update screenshots
- [x] Add `flag` for open URLs
- [x] Please, use `pathlib.Path`
- [x] BUG: Issue when the profile name contains spaces
- [x] Add support for `JSON` files _(prioritize)_

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pybrowsers-profiles",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "dmenu, firefox, librewolf, profiles, rofi",
    "author": null,
    "author_email": "haaag <git.haaag@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/a4/80/9d2d55cf790e1c06b88bd0008e8d7b7d6162a16d4a41d5aaca167c89d2e0/pybrowsers_profiles-0.0.11.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n\n![linux](https://img.shields.io/badge/os-linux-blue?logo=linux)\n[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)\n![PyPI - Version](https://img.shields.io/pypi/v/pybrowsers-profiles)\n[![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![code style - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/format.json)](https://github.com/astral-sh/ruff)\n[![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/python/mypy)\n[![License - MIT](https://img.shields.io/badge/license-MIT-9400d3.svg)](https://spdx.org/licenses/)\n\n</div>\n\n## Profile Launcher\n\n### A Python Script for Effortless Browser Profile Management\n\n### \u2b50 About\n\nThis Python script simplifies launching browser profiles by automatically retrieving profile information from each browser's config directory. It presents these profiles as launch options, saving time and enhancing workflow, especially for users who frequently switch between multiple profiles.\n\n### \u26a1\ufe0f Requirements\n\n- [dmenu](https://tools.suckless.org/dmenu/)\n- [rofi](https://github.com/davatorium/rofi) _(Optional)_\n- [fzf](https://github.com/junegunn/fzf) _(Optional)_\n\n### \ud83d\udce6 Installation\n\n#### Using `pipx` _(recommended)_\n\n```bash\n$ pipx install pybrowsers-profiles\n```\n\n> [pipx Homepage](https://github.com/pypa/pipx)\n\n#### Using `pip` install\n\n```bash\n# Clone repository\n$ git clone \"https://github.com/haaag/PyBrowsers\"\n$ cd PyBrowsers-Profiles\n\n# Create virtual environment & source\n$ python -m venv .venv && source .venv/bin/activate\n\n# Install\n$ pip install .\n```\n\n### \ud83d\ude80 Usage\n\n```bash\n$ pybrowsers --help\n\nusage: pybrowsers [-l] [-d DISABLE] [-e ENABLE] [-f] [-t]\n                  [-m MENU] [-v] [-V] [browser] [-o URL]\n\nSimple script for manage browser's profiles\n\noptions:\n    browser             Browser name\n    -e, --enable        Enable browser\n    -d, --disable       Disable browser\n    -r, --running       Browser running and profile\n    -u, --url           Open <URL> in browser\n    -l, --list          Show browsers list and status\n    -t, --table         Show browsers list with detail\n    -m, --menu          Select menu (default: dmenu)\n    -f, --found         Browsers found\n    -V, --version       Show version\n    -h, --help          Show help\n    -v, --verbose       Verbose mode\n\nlocations:\n    $HOME/.local/share/pybrowsers\n```\n\n#### Use `no flags` to launch menu\n\n```bash\n# Open menu with browsers found\n$ pybrowsers\n```\n\n#### Use flag `browser` for browser's profile\n\n```bash\n# Open menu with profiles list\n$ pybrowsers firefox\n```\n\n#### Use flag `-o, --open` for launching profile with url\n\n<div align=\"left\">\n  <img align=\"center\" src=\"assets/flag-open-with-browser.png\">\n</div>\n\n#### Use flag `-m, --menu` to specify the launcher you want to use _(default: `dmenu`)_\n\n<div align=\"left\">\n  <img align=\"center\" src=\"assets/flag-rofi-dark.gif\">\n</div>\n\n#### Use flag `-l, --list` for status\n\n<div align=\"left\">\n  <img align=\"center\" src=\"assets/flag-list.png\">\n</div>\n<br>\n\n#### Use flag `-d, --disable` or `-e, --enable`\n\n```bash\n# Disable browser (won't appear in `browsers found`)\n$ pybrowsers -d firefox\n\n# Enable browser\n$ pybrowsers -e firefox\n```\n\n#### Use flag `-r, --running`\n\nThis flag will show all running browsers and profiles, as long as it has been\nopened with `pybrowsers`\n\n```bash\n$ pybrowsers -r --url <URL>\n```\n\n### \u2795 Add Browser\n\nYou can add a browser creating a `JSON` file in `$XDG_DATA_HOME/pybrowsers/` or\n`~/.local/share/pybrowsers`\n\n#### Example\n\n```json\n{\n  \"name\": \"LibreWolf\",\n  \"command\": \"librewolf\",\n  \"path\": \"~/.librewolf/profiles.ini\",\n  \"engine\": \"gecko\",\n  \"enabled\": true\n}\n```\n\n### \ud83c\udf10 Browsers\n\n- [Firefox](https://www.mozilla.org/firefox/download/thanks/)\n- [LibreWolf](https://librewolf.net/)\n- [Chromium](https://www.chromium.org/getting-involved/download-chromium/)\n- Brave\n- Google Chrome\n\n### \ud83e\uddf0 Dependencies\n\n- [PySelector](https://pypi.org/project/pyselector/)\n\n### \ud83e\uddf0 TODO\n\n- [ ] Create `interactive menu` for adding browser data\n- [x] Update screenshots\n- [x] Add `flag` for open URLs\n- [x] Please, use `pathlib.Path`\n- [x] BUG: Issue when the profile name contains spaces\n- [x] Add support for `JSON` files _(prioritize)_\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2023-present haaag <git.haaag@gmail.com>\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy of this\n        software and associated documentation files (the \"Software\"), to deal in the Software\n        without restriction, including without limitation the rights to use, copy, modify,\n        merge, publish, distribute, sublicense, and/or sell copies of the Software, and to\n        permit persons to whom the Software is furnished to do so, subject to the following\n        conditions:\n        \n        The above copyright notice and this permission notice shall be included in all copies\n        or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,\n        INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR\n        PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\n        LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\n        TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE\n        USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "Simple script for manage browser's profiles.",
    "version": "0.0.11",
    "project_urls": {
        "Bug Tracker": "https://github.com/haaag/PyBrowsers-Profiles/issues",
        "Homepage": "https://github.com/haaag/PyBrowsers-Profiles"
    },
    "split_keywords": [
        "dmenu",
        " firefox",
        " librewolf",
        " profiles",
        " rofi"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "710e4934b2175194b48402b5b0aa426aa6263eb9a83bd5b734426790834570f3",
                "md5": "c6c8498577cec5e66ad5f923ca533115",
                "sha256": "4d8bb8293119654ee22984332c7cac682583ed6501ec9d7f441b5919ad6883f6"
            },
            "downloads": -1,
            "filename": "pybrowsers_profiles-0.0.11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c6c8498577cec5e66ad5f923ca533115",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 11124,
            "upload_time": "2024-04-22T15:22:25",
            "upload_time_iso_8601": "2024-04-22T15:22:25.530919Z",
            "url": "https://files.pythonhosted.org/packages/71/0e/4934b2175194b48402b5b0aa426aa6263eb9a83bd5b734426790834570f3/pybrowsers_profiles-0.0.11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a4809d2d55cf790e1c06b88bd0008e8d7b7d6162a16d4a41d5aaca167c89d2e0",
                "md5": "2718bd24181292de5a8c4bbafd77ae76",
                "sha256": "a75ea85614de27986195b05f21b101d267e8d74538001fd8b1c71374bbe15a66"
            },
            "downloads": -1,
            "filename": "pybrowsers_profiles-0.0.11.tar.gz",
            "has_sig": false,
            "md5_digest": "2718bd24181292de5a8c4bbafd77ae76",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 9772,
            "upload_time": "2024-04-22T15:22:23",
            "upload_time_iso_8601": "2024-04-22T15:22:23.736156Z",
            "url": "https://files.pythonhosted.org/packages/a4/80/9d2d55cf790e1c06b88bd0008e8d7b7d6162a16d4a41d5aaca167c89d2e0/pybrowsers_profiles-0.0.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-22 15:22:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "haaag",
    "github_project": "PyBrowsers-Profiles",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "pyselector",
            "specs": [
                [
                    "==",
                    "0.0.25"
                ]
            ]
        }
    ],
    "lcname": "pybrowsers-profiles"
}
        
Elapsed time: 0.33361s