Skip to content

installation-methods.md

Latest commit

 

History

History
108 lines (74 loc) · 2.51 KB

installation-methods.md

File metadata and controls

108 lines (74 loc) · 2.51 KB
Raw

Installation Methods

This guide describes different ways to install DocGen.

Method 1: Private GitLab PyPI registry

Doc-Gen is not published to the public PyPI index. Authorized users can install the immutable release package from its private GitLab project registry with a deploy token that has read_package_registry permission:

python -m pip install \
  --index-url "https://<deploy-token-user>:<deploy-token>@gitlab.com/api/v4/projects/<project-id>/packages/pypi/simple" \
  "doc-gen==1.0.2"

A release-candidate tag such as v1.0.0-rc.1 is stored as the canonical PEP 440 version 1.0.0rc1:

python -m pip install \
  --index-url "https://<deploy-token-user>:<deploy-token>@gitlab.com/api/v4/projects/<project-id>/packages/pypi/simple" \
  "doc-gen==1.0.0rc1"

Do not commit tokens. Disable GitLab package forwarding when resolution must remain strictly private, and avoid --extra-index-url for private package names.

Verify installation:

doc-gen --help

Method 2: GitHub

Install directly from the GitHub repository:

pip install git+https://github.com/devalltect00/doc-gen.git

Install a specific version:

pip install git+https://github.com/devalltect00/doc-gen.git@v1.0.2

Method 3: Docker

Pull the Docker image:

docker pull doc-gen

Run DocGen in a container:

docker run --rm doc-gen structure generate

Mount your project:

docker run --rm -v $(pwd):/workspace doc-gen structure generate

Method 4: Development Install

Clone and install in development mode:

git clone https://github.com/devalltect00/doc-gen.git
cd doc-gen
python -m venv .venv
source .venv/bin/activate  # or .venv\Scripts\activate on Windows
pip install -e .[dev]

Choosing a Method

Method Best For
Private GitLab PyPI Authorized deployments
GitHub Latest development version
Docker Isolated environment
Development Contributing to the project

Verification

After installation, verify by running:

doc-gen structure generate

This should create a PROJECT_STRUCTURE.md file.

Related Documentation