Skip to main content

Huge file viewer control for prompt-toolkit

Project description

CI coveralls PyPI github


pthugefileviewer is a control for prompt-toolkit that can display huge files. It does so by mmap'ing the file and only reading the lines shown in the screen. It avoids any operation that would require reading the whole file, like counting the lines.



pthugefileviewer can be installed via pypi:

pip install pthugefileviewer

For nix users, it is also available as a flake.


We can also clone the github repository and install pthugefileviewer from it with:

pip install .

We can also install it for the current user only by running instead:

pip install --user .


pthugefileviewer uses the standard python3 infra. To develop and test the module:

  • Clone the repository and go into the directory:
    git clone
    cd pthugefileviewer
  • Use venv to create a local virtual environment with
    python -m venv venv
  • Activate the environment by running the shell-specific activate script in ./venv/bin/. For [fish], for instance, run:
    source ./venv/bin/
  • Install pthugefileviewer in "editable mode":
    pip install -e '.[test]'
  • To run the tests:
    Or, to run the tests with coverage:
    pytest --cov
  • Finally, to exit the environment and clean it up:
    rm -rf venv

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pthugefileviewer-0.5.0.tar.gz (9.4 kB view hashes)

Uploaded Source

Built Distribution

pthugefileviewer-0.5.0-py3-none-any.whl (11.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page