Merge branch 'master' into master

Author: subzeroid

.github/actions/install-dependencies/action.sh

@@ -11,4 +11,9 @@ fi
 if [[ "${INSTALL_TEST_REQUIREMENTS}" == "true"  ]]; then
   echo "Installing test requirements"
   pip install -r requirements-test.txt
-fi
+fi
+
+if [[ "${INSTALL_DOCS_REQUIREMENTS}" == "true"  ]]; then
+  echo "Installing docs requirements"
+  pip install -r requirements-docs.txt
+fi

.github/actions/install-dependencies/action.yml

@@ -9,6 +9,10 @@ inputs:
     description: "Should requirements-test.txt be installed"
     default: "false"
     required: false
+  docs-requirements:
+    description: "Should requirements-docs.txt be installed"
+    default: "false"
+    required: false
 runs:
   using: "composite"
   steps:
@@ -17,4 +21,5 @@ runs:
       shell: "bash"
       env:
         INSTALL_REQUIREMENTS: ${{ inputs.requirements }}
-        INSTALL_TEST_REQUIREMENTS: ${{ inputs.test-requirements }}
+        INSTALL_TEST_REQUIREMENTS: ${{ inputs.test-requirements }}
+        INSTALL_DOCS_REQUIREMENTS: ${{ inputs.docs-requirements }}

.github/actions/publish-docs-with-mike/action.yml

@@ -34,4 +34,4 @@ runs:
         USER_EMAIL: ${{ inputs.email }}
         VERSION_NAME: ${{ inputs.version_name }}
         NEW_VERSION: ${{ inputs.new_version }}
-        RELEASE_TAG: ${{ github.event.release.tag_name }}
+        RELEASE_TAG: ${{ github.event.release.tag_name }}

.github/actions/publish-docs-with-mike/configure_git_user.sh

@@ -42,4 +42,4 @@ fi
 
 echo "::debug::Falling back to GITHUB_ACTOR"
 LOGIN="${GITHUB_ACTOR:-github_action}"
-set_and_exit "${LOGIN}" "${LOGIN}${NO_REPLY_SUFFIX}"
+set_and_exit "${LOGIN}" "${LOGIN}${NO_REPLY_SUFFIX}"

.github/actions/publish-docs-with-mike/update_docs_for_version.sh

@@ -12,4 +12,4 @@ else
   mike retitle --message "Remove latest from title of ${PREV_LATEST}" "${PREV_LATEST}" "${PREV_LATEST}"
 fi
 echo "mike deploy --update-aliases --title \"${NEW_VERSION} (latest)\" \"${NEW_VERSION}\" \"latest\""
-mike deploy --update-aliases --title "${NEW_VERSION} (latest)" "${NEW_VERSION}" "latest"
+mike deploy --update-aliases --title "${NEW_VERSION} (latest)" "${NEW_VERSION}" "latest"

.github/workflows/python-package.yml

@@ -9,7 +9,7 @@ on:
   pull_request: {}
 
 env:
-  PYTHON_VERSION: "3.9.14"
+  PYTHON_VERSION: "3.13.5"
 
 jobs:
   bandit:
@@ -68,7 +68,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ "3.10" ]
+        python-version: [ "3.13.5" ]
     env:
       TEST_ACCOUNTS_URL: ${{ secrets.TEST_ACCOUNTS_URL }}
     steps:
@@ -113,6 +113,7 @@ jobs:
         with:
           requirements: "true"
           test-requirements: "true"
+          docs-requirements: "true"
 
       - name: Build Docs
         run: mkdocs build --strict
@@ -141,8 +142,9 @@ jobs:
         with:
           requirements: "true"
           test-requirements: "true"
+          docs-requirements: "true"
 
-      - name: Push documentaiton changes
+      - name: Push documentation changes
         uses: ./.github/actions/publish-docs-with-mike
         with:
           version_name: dev

README.md

@@ -1,7 +1,7 @@
-If you want to work with Instagrapi (business interests), we strongly advise you to prefer [HikerAPI](https://hikerapi.com/p/bkXQlaVe) project.
+If you want to work with Instagrapi (business interests), we strongly advise you to prefer [HikerAPI SaaS](https://hikerapi.com/p/bkXQlaVe) project.
 However, you won't need to spend weeks or even months setting it up.
-The best service available today is [HikerAPI](https://hikerapi.com/p/bkXQlaVe), which handles 4–5 million daily requests, provides support around-the-clock, and offers partners a special rate.
-In many instances, our clients tried to save money and preferred instagrapi, but in our experience, they ultimately returned to [HikerAPI](https://hikerapi.com/p/bkXQlaVe) after spending much more time and money.
+The best service available today is [HikerAPI SaaS](https://hikerapi.com/p/bkXQlaVe), which handles 4–5 million daily requests, provides support around-the-clock, and offers partners a special rate.
+In many instances, our clients tried to save money and preferred instagrapi, but in our experience, they ultimately returned to [HikerAPI SaaS](https://hikerapi.com/p/bkXQlaVe) after spending much more time and money.
 It will be difficult to find good accounts, good proxies, or resolve challenges, and IG will ban your accounts.
 
 The instagrapi more suits for testing or research than a working business!
@@ -19,6 +19,7 @@ The instagrapi more suits for testing or research than a working business!
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/instagrapi)
 ![Checked with mypy](https://img.shields.io/badge/mypy-checked-blue)
 
+> To run instagrapi you may need a [cheap and powerful server](https://powervps.net/?from=96837), I recommend using my promo you will support the author of this library!
 
 Features:
 
@@ -27,7 +28,7 @@ Features:
 * Getting public data of post, story, album, Reels, IGTV data and the ability to download content
 * Getting public data of hashtag and location data, as well as a list of posts for them
 * Getting public data of all comments on a post and a list of users who liked it
-* Management of [proxy servers](https://soax.com/?r=sEysufQI), mobile devices and challenge resolver
+* Management of [proxy servers](https://soax.com?afmc=sEysufQI), mobile devices and challenge resolver
 * Login by username and password, sessionid and support 2FA
 * Managing messages and threads for Direct and attach files
 * Download and upload a Photo, Video, IGTV, Reels, Albums and Stories
@@ -39,7 +40,7 @@ Features:
 
 Fast and effective Instagram Private API wrapper (public+private requests and challenge resolver) without selenium. Use the most recent version of the API from Instagram, which was obtained using reverse-engineering with Charles Proxy and [Proxyman](https://proxyman.io/).
 
-*Instagram API valid for **16 Dec 2023** (last reverse-engineering check)*
+*Instagram API valid for **25 May 2025** (last reverse-engineering check)*
 
 Support **Python >= 3.9**
 
@@ -83,6 +84,47 @@ user_id = cl.user_id_from_username(ACCOUNT_USERNAME)
 medias = cl.user_medias(user_id, 20)
 ```
 
+### Session with persistence
+
+``` python
+from instagrapi import Client
+
+cl = Client()
+cl.login(USERNAME, PASSWORD)
+cl.dump_settings("session.json")
+
+# reload later without entering credentials again
+cl = Client()
+cl.load_settings("session.json")
+cl.login(USERNAME, PASSWORD)
+```
+
+### Login using a sessionid
+
+``` python
+from instagrapi import Client
+
+cl = Client()
+cl.login_by_sessionid("<your_sessionid>")
+```
+
+### List and download another user's posts
+
+``` python
+from instagrapi import Client
+
+cl = Client()
+cl.login(USERNAME, PASSWORD)
+
+target_id = cl.user_id_from_username("target_user")
+posts = cl.user_medias(target_id, amount=10)
+for media in posts:
+    # download photos to the current folder
+    cl.photo_download(media.pk)
+
+See [examples/session_login.py](examples/session_login.py) for a standalone script demonstrating these login methods.
+```
+
 <details>
     <summary>Additional example</summary>
 

docker/devbox.dockerfile

@@ -1,11 +1,10 @@
-FROM python:3.11.4-buster
+FROM python:3.13-bookworm
 
 ARG _USER="instagrapi"
 ARG _UID="1001"
 ARG _GID="100"
 ARG _SHELL="/bin/bash"
 
-
 RUN useradd -m -s "${_SHELL}" -N -u "${_UID}" "${_USER}"
 
 ENV USER ${_USER}
@@ -15,15 +14,13 @@ ENV HOME /home/${_USER}
 ENV PATH "${HOME}/.local/bin/:${PATH}"
 ENV PIP_NO_CACHE_DIR "true"
 
-
 RUN mkdir /app && chown ${UID}:${GID} /app
 
 USER ${_USER}
 
 COPY --chown=${UID}:${GID} ./requirements* /app/
-COPY --chown=${UID}:${GID} ./util /app/util/
 WORKDIR /app
 
-RUN pip install -r requirements.txt -r requirements-test.txt
+RUN pip install -r requirements.txt -r requirements-test.txt -r requirements-docs.txt
 
-CMD bash
+CMD bash

docker/lock_requirements.sh

@@ -5,4 +5,4 @@ pip install -r requirements.txt
 printf "# THIS IS AN AUTOGENERATED LOCKFILE. DO NOT EDIT MANUALLY.\n" > requirements.lock
 pip freeze --disable-pip-version-check --all >> requirements.lock
 
-echo "Rebuild containers to verify there are no conflicts."
+echo "Rebuild containers to verify there are no conflicts."

docker/run_tests.sh

@@ -18,7 +18,7 @@ while [[ $# -gt 0 ]]; do
     case $arg in
         --format-code)
         BLACK_ACTION="--quiet"
-        ISORT_ACTION="--recursive"
+        ISORT_ACTION=""
         ;;
         -h|--help)
         usage
@@ -36,8 +36,8 @@ done
 
 python -m unittest tests.FakeClientTestCase tests.ClientPublicTestCase
 
-echo "Running iSort..."
+echo "Running isort..."
 isort ${ISORT_ACTION} instagrapi
 
 echo "Running flake8..."
-flake8 instagrapi --count --exit-zero --statistics
+flake8 instagrapi --count --exit-zero --statistics