[pull] master from n8henrie:master

.github/FUNDING.yml

@@ -2,11 +2,11 @@
 
 github: [n8henrie]
 custom: ["https://n8henrie.com/donate"]
-patreon: # Replace with a single Patreon username
+patreon: n8henrie
 open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
+liberapay: n8henrie
 issuehunt: # Replace with a single IssueHunt username
 otechie: # Replace with a single Otechie username

.github/ISSUE_TEMPLATE.md

@@ -6,7 +6,7 @@
 
 
 
-## [WHYT](http://mattgemmell.com/what-have-you-tried)
+## [WHYT](https://web.archive.org/web/20140712194323/http://mattgemmell.com/what-have-you-tried/)
 
 
 

.github/dependabot.yml

@@ -0,0 +1 @@
+version: 2

.github/workflows/python-package.yml

@@ -2,40 +2,51 @@ name: Python package
 
 on:
   push:
-    branches: [ master, dev ]
+    branches: [ master  ]
   pull_request:
-    branches: [ master, dev ]
+    branches: [ master ]
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version:
-          - "3.7"
-          - "3.8"
           - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
 
     env:
-      TOX_TESTENV_PASSENV: "XAUTHORITY DISPLAY"
+      TOX_OVERRIDE: "testenv.pass_env+=XAUTHORITY,DISPLAY,TEST_BROWSER_NAME,TEST_BROWSER_PATH"
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
-    - name: pip cache
-      uses: actions/cache@v2
-      with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements*.txt') }}
-        restore-keys: |
-          ${{ runner.os }}-pip-
+        cache: 'pip'
     - name: Install tox
-      run: python -m pip install "tox>=3,<4"
-    - name: Run tests via tox
+      run: python -m pip install .[test]
+    - name: Install Brave
+      # https://brave.com/linux/#release-channel-installation
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y apt-transport-https curl
+        sudo curl -fsSLo /usr/share/keyrings/brave-browser-archive-keyring.gpg https://brave-browser-apt-release.s3.brave.com/brave-browser-archive-keyring.gpg
+        echo "deb [signed-by=/usr/share/keyrings/brave-browser-archive-keyring.gpg] https://brave-browser-apt-release.s3.brave.com/ stable main" |
+          sudo tee /etc/apt/sources.list.d/brave-browser-release.list
+        sudo apt-get update
+        sudo apt-get install --yes brave-browser
+    - name: Run tests via tox (Chromium)
+      run: xvfb-run -- python -m tox -e py
+    - name: Run tests via tox (Brave)
+      env:
+        TEST_BROWSER_NAME: Brave
+        TEST_BROWSER_PATH: /usr/bin/brave-browser
       run: xvfb-run -- python -m tox -e py
-    - if: "matrix.python-version == '3.9'"
+    - if: "matrix.python-version == '3.12'"
       name: Lint
       run: python -m tox -e lint

.github/workflows/python-publish.yml

@@ -7,18 +7,19 @@ on:
 
 jobs:
   deploy:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: '3.x'
+        cache: 'pip'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install build setuptools wheel twine
+        python -m pip install .[dev]
     - name: Build and publish
       env:
         TWINE_USERNAME: __token__

.python-version

@@ -1,3 +1,5 @@
-3.9.5
-3.8.7
-3.7.10
+3.11.0
+3.10.7
+3.9.13
+3.8.13
+3.7.13

.readthedocs.yml

@@ -1,2 +1,19 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+---
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+sphinx:
+  configuration: docs/conf.py
+
 python:
-  version: 3.7
+  install:
+    - method: pip
+      path: .

AUTHORS.md

@@ -1,11 +1,10 @@
 # Credits
 
-## Development Lead
+## Core Contributors
 
 - [Nathan Henrie](http://n8henrie.com) <nate@n8henrie.com>
+- [jakob](https://github.com/grandchild) <grandchild@mailbox.org>
 
-## Contributors
+## Other Contributors
 
-- [Kostis Anagnostopoulos](https://github.com/ankostis)
-- [Dani García](https://github.com/dani14-96)
-- [Thinh Nguyen](https://github.com/Taik)
+- <https://github.com/n8henrie/pycookiecheat/graphs/contributors>

CHANGELOG.md

@@ -1,5 +1,63 @@
 # [Changelog](https://keepachangelog.com)
 
+## v0.8.0 :: 20241102
+
+### Breaking Changes
+
+- `url` is now a positional argument (no longer requires `-u`)
+- Browser type must be passed as a variant of the `BrowserType` enum; string
+  is no longer supported
+- Now requires python >= 3.9
+
+### CLI Enhancements
+
+- Assume `https://` if the scheme is not specified
+- Add `--version` flag (thanks @samiam)
+- Add `-c` flag to specify custom path to cookie file (thanks @samiam)
+- Convert the `browser` argument into a `BrowserType` at parse time
+
+### Fixes / Other
+
+- Fix new path to Firefox profile on MacOS (thanks @MattMuffin)
+- Support Chrome's new v24 cookies (thanks @chrisgavin)
+- Add new top-level `get_cookies` function that can be used for all supported
+  browsers
+  - No longer need to use separate `chrome_cookies` or `firefox_cookies`
+    functions, but will leave these around for backwards compatibility
+- Use `ruff` instead of hodgepodge of `flake8` / `pycodestyle` / `black` and
+  others
+
+## v0.7.0 :: 20240105
+
+- Now requires python >= 3.8
+    - 3.7 is now EoL: https://devguide.python.org/versions/
+    - pycookiecheat seems to build and run on 3.7, but several test
+      dependencies require versions that are either incompatible with 3.12 or
+      3.7
+- Add `BrowserType` enum
+    - Instead of passing a string (e.g. "chrome"), please import and use a
+      `BrowserType` (e.g. `BrowserType.CHROME`)
+    - Add deprecation warning for passing strings
+- Added a nix flake to facilitate testing multiple python versions
+- Add basic logging
+- Add CLI tool
+- Add `as_cookies` parameter to allow returning `list[Cookie]` instead of
+  `dict` (without breaking backward compatibility)
+- Loosen dependency constrains, which should make usage as a library easier
+
+## v0.6.0 :: 20230324
+
+- Add firefox support, thanks to @grandchild
+    - Also would like to welcome @grandchild as a new member of the
+      pycookiecheat team!
+
+## v0.5.0 :: 20230324
+
+- Add support for Brave thanks to @chrisgavin!
+- Add support for Slack thanks to @hraftery!
+- Migrate config to pyproject.toml alone
+- Minor cleanup to codebase and tests
+
 ## v0.4.7 :: 20210826
 
 - No noteworthy API changes, hence the bugfix version bump, but some major

CONTRIBUTING.md

@@ -61,12 +61,6 @@ for local development.
         $ git clone git@github.com:your_name_here/pycookiecheat.git
         $ cd pycookiecheat
 
-1. Check out the `dev` branch, where development happens prior to being merged
-   into `master`. Your changes should be based on the `dev` branch, and your PR
-   should eventually be requested against my `dev` branch.
-
-        $ git checkout dev
-
 1.  Install your local copy into a virtualenv (`venv` in modern python). Some
     linux distributions will require you to install `python-venv` or
     `python3-venv`, other times it will already be bundled with python. There
@@ -96,7 +90,7 @@ for local development.
         $ git commit -m "Your detailed description of your changes."
         $ git push origin name-of-your-bugfix-or-feature
 
-1.  Submit a pull request through the GitHub website against my `dev` branch.
+1.  Submit a pull request through the GitHub website against the `master` branch.
 
 Pull Request Guidelines
 -----------------------

README.md

@@ -6,14 +6,15 @@ status](https://github.com/n8henrie/pycookiecheat/actions/workflows/python-packa
 Borrow cookies from your browser's authenticated session for use in Python
 scripts.
 
--   Free software: MIT
--   Documentation: http://n8h.me/HufI1w
+- Free software: MIT
+- [Documentation](https://n8henrie.com/2013/11/use-chromes-cookies-for-easier-downloading-with-python-requests/)
 
 ## Installation
 
 **NB:** Use `pip` and `python` instead of `pip3` and `python3` if you're still
 on Python 2 and using pycookiecheat < v0.4.0. pycookiecheat >= v0.4.0 requires
-Python 3.5+, and may soon go to 3.6+.
+Python 3 and in general will aim to support python versions that are stable and
+not yet end-of-life: <https://devguide.python.org/versions>.
 
 - `python3 -m pip install pycookiecheat`
 
@@ -41,28 +42,66 @@ Alternatively, some users have suggested running Chrome with the
 
 ## Usage
 
+### As a Command-Line Tool
+
+After installation, the CLI tool can be run as a python module `python -m` or
+with a standalone console script:
+
+```console
+$ python -m pycookiecheat --help
+usage: pycookiecheat [-h] [-b BROWSER] [-o OUTPUT_FILE] [-v] [-c COOKIE_FILE]
+                     [-V]
+                     url
+
+Copy cookies from Chrome or Firefox and output as json
+
+positional arguments:
+  url
+
+options:
+  -h, --help            show this help message and exit
+  -b BROWSER, --browser BROWSER
+  -o OUTPUT_FILE, --output-file OUTPUT_FILE
+                        Output to this file in netscape cookie file format
+  -v, --verbose         Increase logging verbosity (may repeat), default is
+                        `logging.ERROR`
+  -c COOKIE_FILE, --cookie-file COOKIE_FILE
+                        Cookie file
+  -V, --version         show program's version number and exit
+
+```
+
+By default it prints the cookies to stdout as JSON but can also output a file in
+Netscape Cookie File Format.
+
+### As a Python Library
+
 ```python
-from pycookiecheat import chrome_cookies
+from pycookiecheat import BrowserType, get_cookies
 import requests
 
-url = 'http://example.com/fake.html'
+url = 'https://n8henrie.com'
 
 # Uses Chrome's default cookies filepath by default
-cookies = chrome_cookies(url)
+cookies = get_cookies(url)
 r = requests.get(url, cookies=cookies)
+
+# Using an alternate browser
+cookies = get_cookies(url, browser=BrowserType.CHROMIUM)
 ```
 
-Use the `cookie_file` keyword-argument to specify a different filepath for the
-cookies-file: `chrome_cookies(url, cookie_file='/abspath/to/cookies')`
+Use the `cookie_file` keyword-argument to specify a different path to the file
+containing your cookies:
+`get_cookies(url, cookie_file='/abspath/to/cookies')`
 
-Keep in mind that pycookiecheat defaults to looking for cookies for
-Chromium, not Google Chrome, so if you're using the latter, you'll need to
-manually specify something like
-`"/home/username/.config/google-chrome/Default/Cookies"` as your `cookie_file`.
+You may be able to retrieve cookies for alternative Chromium-based browsers by
+manually specifying something like
+`"/home/username/.config/BrowserName/Default/Cookies"` as your `cookie_file`.
 
 ## Features
 
-- Returns decrypted cookies from Google Chrome on OSX or Linux.
+- Returns decrypted cookies from Google Chrome, Brave, or Slack, on MacOS or
+  Linux.
 - Optionally outputs cookies to file (thanks to Muntashir Al-Islam!)
 
 ## FAQ / Troubleshooting
@@ -93,9 +132,9 @@ libffi-dev python-dev` prior to installing with `pip`.
 
 On KDE, Chrome defaults to using KDE's own keyring, KWallet. For pycookiecheat to support KWallet the [`dbus-python`](https://pypi.org/project/dbus-python/) package must be installed.
 
-### How do I install the dev branch with pip?
+### How do I install the (unreleased) master branch with pip?
 
-- `python -m pip install git+https://github.com/n8henrie/pycookiecheat@dev`
+- `python -m pip install git+https://github.com/n8henrie/pycookiecheat@master`
 
 ## Buy Me a Coffee
 

TODO.txt

@@ -0,0 +1,4 @@
+MSPV:
+    - 3.10
+        - Replace `t.Union` with `|`
+        - several places that match would work well