mirror of
https://github.com/kirill-markin/repo-to-text.git
synced 2025-12-05 19:12:24 -08:00
docker instructions cleanup
This commit is contained in:
parent
7c32b7a565
commit
cde732c57d
4 changed files with 67 additions and 33 deletions
27
DOCKER.md
27
DOCKER.md
|
|
@ -1,27 +0,0 @@
|
|||
# Docker Usage Instructions
|
||||
|
||||
## Building and Running
|
||||
|
||||
1. Build the container:
|
||||
```bash
|
||||
docker-compose build
|
||||
```
|
||||
|
||||
2. Start a shell session:
|
||||
```bash
|
||||
docker-compose run --rm repo-to-text
|
||||
```
|
||||
|
||||
Once in the shell, you can run repo-to-text:
|
||||
```bash
|
||||
# Process current directory
|
||||
repo-to-text
|
||||
|
||||
# Process specific directory
|
||||
repo-to-text /home/user/myproject
|
||||
|
||||
# Use with options
|
||||
repo-to-text --output-dir /home/user/output
|
||||
```
|
||||
|
||||
The container mounts your home directory at `/home/user`, allowing access to all your projects.
|
||||
30
Dockerfile
30
Dockerfile
|
|
@ -1,13 +1,33 @@
|
|||
FROM python:3.11-slim
|
||||
FROM python:3.12-slim
|
||||
|
||||
RUN apt-get update && apt-get install -y \
|
||||
# Set environment variables
|
||||
ENV PYTHONUNBUFFERED=1 \
|
||||
PYTHONDONTWRITEBYTECODE=1 \
|
||||
PIP_NO_CACHE_DIR=1
|
||||
|
||||
# Create non-root user
|
||||
RUN useradd -m -s /bin/bash user
|
||||
|
||||
# Install system dependencies
|
||||
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||
tree \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
RUN useradd -m -s /bin/bash user
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
# Copy all necessary files for package installation
|
||||
COPY pyproject.toml README.md ./
|
||||
|
||||
# Copy the package source
|
||||
COPY repo_to_text ./repo_to_text
|
||||
|
||||
# Install the package
|
||||
RUN pip install --no-cache-dir -e .
|
||||
|
||||
# Copy remaining files
|
||||
COPY . .
|
||||
RUN pip install -e . && pip install pyperclip
|
||||
|
||||
# Set default user
|
||||
USER user
|
||||
|
||||
ENTRYPOINT ["repo-to-text"]
|
||||
|
|
|
|||
38
README.md
38
README.md
|
|
@ -98,6 +98,44 @@ You can customize the behavior of `repo-to-text` with the following options:
|
|||
|
||||
This will write the output directly to `myfile.txt` instead of creating a timestamped file.
|
||||
|
||||
## Docker Usage
|
||||
|
||||
### Building and Running
|
||||
|
||||
1. Build the container:
|
||||
|
||||
```bash
|
||||
docker compose build
|
||||
```
|
||||
|
||||
2. Start a shell session:
|
||||
|
||||
```bash
|
||||
docker compose run --rm repo-to-text
|
||||
```
|
||||
|
||||
Once in the shell, you can run `repo-to-text`:
|
||||
|
||||
- Process current directory:
|
||||
|
||||
```bash
|
||||
repo-to-text
|
||||
```
|
||||
|
||||
- Process specific directory:
|
||||
|
||||
```bash
|
||||
repo-to-text /home/user/myproject
|
||||
```
|
||||
|
||||
- Use with options:
|
||||
|
||||
```bash
|
||||
repo-to-text --output-dir /home/user/output
|
||||
```
|
||||
|
||||
The container mounts your home directory at `/home/user`, allowing access to all your projects.
|
||||
|
||||
## Settings
|
||||
|
||||
`repo-to-text` also supports configuration via a `.repo-to-text-settings.yaml` file. By default, the tool works without this file, but you can use it to customize what gets included in the final text file.
|
||||
|
|
|
|||
|
|
@ -1,10 +1,13 @@
|
|||
services:
|
||||
repo-to-text:
|
||||
build: .
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Dockerfile
|
||||
volumes:
|
||||
- ${HOME:-/home/user}:/home/user
|
||||
working_dir: /home/user
|
||||
environment:
|
||||
- HOME=/home/user
|
||||
user: "${UID:-1000}:${GID:-1000}"
|
||||
init: true
|
||||
entrypoint: ["/bin/bash"]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue