Merge branch 'main' into VsCode-Extension

Author: filipchristiansen

.pre-commit-config.yaml

@@ -44,7 +44,7 @@ repos:
       - id: black
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.19.1
+    rev: v3.20.0
     hooks:
       - id: pyupgrade
         description: "Automatically upgrade syntax for newer versions."
@@ -73,7 +73,7 @@ repos:
       - id: djlint-reformat-jinja
 
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.44.0
+    rev: v0.45.0
     hooks:
       - id: markdownlint
         description: "Lint markdown files."
@@ -88,7 +88,7 @@ repos:
         files: ^src/
 
   - repo: https://github.com/pycqa/pylint
-    rev: v3.3.6
+    rev: v3.3.7
     hooks:
       - id: pylint
         name: pylint for source
@@ -99,6 +99,7 @@ repos:
             "fastapi[standard]>=0.109.1",
             pydantic,
             pytest-asyncio,
+            pytest-mock,
             python-dotenv,
             slowapi,
             starlette>=0.40.0,
@@ -117,6 +118,7 @@ repos:
             "fastapi[standard]>=0.109.1",
             pydantic,
             pytest-asyncio,
+            pytest-mock,
             python-dotenv,
             slowapi,
             starlette>=0.40.0,

.vscode/launch.json

@@ -0,0 +1,12 @@
+{
+    "configurations": [
+        {
+            "name": "Python Debugger: Module",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "uvicorn",
+            "args": ["server.main:app", "--host", "0.0.0.0", "--port", "8000"],
+            "cwd": "${workspaceFolder}/src"
+        }
+    ]
+}

CONTRIBUTING.md

@@ -48,9 +48,9 @@ Thanks for your interest in contributing to Gitingest! 🚀 Gitingest aims to be
    pytest
    ```
 
-8. Navigate to src folder
+8. Run the local web server
 
-   1. Build the Docker image
+   1. Navigate to src folder
 
         ``` bash
         cd src

README.md

@@ -32,14 +32,39 @@ You can also replace `hub` with `ingest` in any GitHub URL to access the corresp
 
 ## 📚 Requirements
 
-- Python 3.7+
+- Python 3.8+
+- For private repositories: A GitHub Personal Access Token (PAT). You can generate one at [https://github.com/settings/personal-access-tokens](https://github.com/settings/personal-access-tokens) (Profile → Settings → Developer Settings → Personal Access Tokens → Fine-grained Tokens)
 
-## 📦 Installation
+### 📦 Installation
 
-``` bash
+Gitingest is available on [PyPI](https://pypi.org/project/gitingest/).
+You can install it using `pip`:
+
+```bash
 pip install gitingest
 ```
 
+However, it might be a good idea to use `pipx` to install it.
+You can install `pipx` using your preferred package manager.
+
+```bash
+brew install pipx
+apt install pipx
+scoop install pipx
+...
+```
+
+If you are using pipx for the first time, run:
+
+```bash
+pipx ensurepath
+```
+
+```bash
+# install gitingest
+pipx install gitingest
+```
+
 ## 🧩 Browser Extension Usage
 
 <!-- markdownlint-disable MD033 -->
@@ -57,17 +82,37 @@ Issues and feature requests are welcome to the repo.
 The `gitingest` command line tool allows you to analyze codebases and create a text dump of their contents.
 
 ```bash
-# Basic usage
+# Basic usage (writes to digest.txt by default)
 gitingest /path/to/directory
 
 # From URL
 gitingest https://github.com/cyclotruc/gitingest
 
-# See more options
-gitingest --help
+# or from specific subdirectory
+gitingest https://github.com/cyclotruc/gitingest/tree/main/src/gitingest/utils
 ```
 
-This will write the digest in a text file (default `digest.txt`) in your current working directory.
+For private repositories, use the `--token/-t` option.
+
+```bash
+# Get your token from https://github.com/settings/personal-access-tokens
+gitingest https://github.com/username/private-repo --token github_pat_...
+
+# Or set it as an environment variable
+export GITHUB_TOKEN=github_pat_...
+gitingest https://github.com/username/private-repo
+```
+
+By default, the digest is written to a text file (`digest.txt`) in your current working directory. You can customize the output in two ways:
+
+- Use `--output/-o <filename>` to write to a specific file.
+- Use `--output/-o -` to output directly to `STDOUT` (useful for piping to other tools).
+
+See more options and usage details with:
+
+```bash
+gitingest --help
+```
 
 ## 🐍 Python package usage
 
@@ -79,6 +124,21 @@ summary, tree, content = ingest("path/to/directory")
 
 # or from URL
 summary, tree, content = ingest("https://github.com/cyclotruc/gitingest")
+
+# or from a specific subdirectory
+summary, tree, content = ingest("https://github.com/cyclotruc/gitingest/tree/main/src/gitingest/utils")
+```
+
+For private repositories, you can pass a token:
+
+```python
+# Using token parameter
+summary, tree, content = ingest("https://github.com/username/private-repo", token="github_pat_...")
+
+# Or set it as an environment variable
+import os
+os.environ["GITHUB_TOKEN"] = "github_pat_..."
+summary, tree, content = ingest("https://github.com/username/private-repo")
 ```
 
 By default, this won't write a file but can be enabled with the `output` argument.

pyproject.toml

@@ -11,7 +11,7 @@ dependencies = [
     "python-dotenv",
     "slowapi",
     "starlette>=0.40.0",  # Vulnerable to https://osv.dev/vulnerability/GHSA-f96h-pmfr-66vw
-    "tiktoken",
+    "tiktoken>=0.7.0",  # Support for o200k_base encoding
     "tomli",
     "typing_extensions; python_version < '3.10'",
     "uvicorn>=0.11.7",  # Vulnerable to https://osv.dev/vulnerability/PYSEC-2020-150
@@ -23,7 +23,6 @@ classifiers=[
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",

requirements-dev.txt

@@ -5,3 +5,4 @@ pre-commit
 pylint
 pytest
 pytest-asyncio
+pytest-mock

requirements.txt

@@ -4,6 +4,6 @@ pydantic
 python-dotenv
 slowapi
 starlette>=0.40.0  # Vulnerable to https://osv.dev/vulnerability/GHSA-f96h-pmfr-66vw
-tiktoken
+tiktoken>=0.7.0  # Support for o200k_base encoding
 tomli
 uvicorn>=0.11.7  # Vulnerable to https://osv.dev/vulnerability/PYSEC-2020-150