Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for exposing manual pages #1047

Merged
merged 73 commits into from
Dec 2, 2023
Merged

Commits on Aug 24, 2023

  1. Preliminary support for exposing manual pages

    - Can install and uninstall a simple package with manual pages on Linux.
    - Not tested on macOS or Windows.
    - Tests not updated yet.
    peterkuma committed Aug 24, 2023
    Configuration menu
    Copy the full SHA
    8ca1470 View commit details
    Browse the repository at this point in the history
  2. Fix typo in run_post_install_actions

    A function call to expose_resources_globally with a duplicate argument.
    peterkuma committed Aug 24, 2023
    Configuration menu
    Copy the full SHA
    0024793 View commit details
    Browse the repository at this point in the history

Commits on Aug 31, 2023

  1. Merge get_resources with get_man_pages

    - Add a new MAN_SECTIONS constant.
    - Loop over MAN_SECTIONS instead of range(1, 10) when iterating man sections.
    - _dfs_package_resources and get_resources now return a nested list for apps
      and man pages together.
    peterkuma committed Aug 31, 2023
    Configuration menu
    Copy the full SHA
    49b13fb View commit details
    Browse the repository at this point in the history

Commits on Sep 1, 2023

  1. Configuration menu
    Copy the full SHA
    6b88414 View commit details
    Browse the repository at this point in the history

Commits on Sep 3, 2023

  1. Fix printing of unavailable apps and man pages

    This fixes something which might be a small bug in the original code, but also
    affecting the man pages exposition. Post-installation, pipx prints "These apps
    are now globally available", followed by a list of app names. However, if all
    of the apps are unavailable (`exposed_binary_names` is empty and
    `unavailable_binary_names` is non-empty), "These apps are now globally
    available" is not printed, when it probably should. In this case, the list of
    unavailable apps is printed regardless and appears somewhat out of context.
    The same issue affects printing of exposed and unavailable man pages.
    peterkuma committed Sep 3, 2023
    Configuration menu
    Copy the full SHA
    719b0a2 View commit details
    Browse the repository at this point in the history
  2. Fix exposing man pages when symlinks not available

    When symbolic links are not available (e.g. on Windows),
    `get_exposed_man_paths_for_package` failed to produce results because it called
    `get_exposed_paths_for_package` with an incorrect list of man pages. Items in
    this list errornously included the `man<i>` path prefix.
    peterkuma committed Sep 3, 2023
    Configuration menu
    Copy the full SHA
    894cc58 View commit details
    Browse the repository at this point in the history

Commits on Oct 2, 2023

  1. Fix lint formatting issues

    peterkuma committed Oct 2, 2023
    Configuration menu
    Copy the full SHA
    b566c3a View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    ad85f86 View commit details
    Browse the repository at this point in the history
  3. Split get_resources into three functions

    This is to satisfy the linter. The new functions are:
    
    - get_apps_from_entry_points
    - get_resources_from_dist_files
    - get_resources_from_inst_files
    
    get_resources simply collectes the results from the above functions. The
    functionality is unchanged.
    peterkuma committed Oct 2, 2023
    Configuration menu
    Copy the full SHA
    d751f93 View commit details
    Browse the repository at this point in the history
  4. Fix linter errors

    peterkuma committed Oct 2, 2023
    Configuration menu
    Copy the full SHA
    0d4115c View commit details
    Browse the repository at this point in the history

Commits on Oct 3, 2023

  1. Configuration menu
    Copy the full SHA
    5f63729 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    7d0907f View commit details
    Browse the repository at this point in the history

Commits on Oct 4, 2023

  1. Fix an issue with Python < 3.9

    The man pages code used the str.removeprefix method which does not exist in
    older Python versions.
    peterkuma committed Oct 4, 2023
    Configuration menu
    Copy the full SHA
    85995bb View commit details
    Browse the repository at this point in the history
  2. Fix a linter error

    peterkuma committed Oct 4, 2023
    Configuration menu
    Copy the full SHA
    33f8936 View commit details
    Browse the repository at this point in the history
  3. Fix exposing package resources

    can_symlink could prevously be called without the directory existing yet,
    resulting in an error. Also the symlink check was performed on the "man"
    directory instead of individually on the "man/man<i>" subdirectories.
    
    _copy_package_resources is now _copy_package_resource and called per path from
    expose_resources_globally.
    
    _symlink_package_resources is removed, and instead _symlink_package_resource
    is called per path directly from expose_resources_globally.
    
    expose_resources_globally creates the destination directory before calling
    can_symlink, which fixes the error.
    peterkuma committed Oct 4, 2023
    Configuration menu
    Copy the full SHA
    bb8b307 View commit details
    Browse the repository at this point in the history
  4. Fix can_symlink error

    can_symlink is called in _get_venv_resource_paths on local_resource_dir which
    might not exist. Test first if the directory exists.
    peterkuma committed Oct 4, 2023
    Configuration menu
    Copy the full SHA
    e84b809 View commit details
    Browse the repository at this point in the history

Commits on Oct 5, 2023

  1. Improve changelog description of expose manual pages

    Co-authored-by: Tzu-ping Chung <[email protected]>
    peterkuma and uranusjr committed Oct 5, 2023
    Configuration menu
    Copy the full SHA
    e03ec55 View commit details
    Browse the repository at this point in the history
  2. Add documentation of exposing manual pages

    - Add new bullet points to the "How it Works" section.
    - Add description of how to use data_files with manual pages in setup.py to the
      "Developing for pipx" section.
    - Add description to the pipx install command help.
    peterkuma committed Oct 5, 2023
    Configuration menu
    Copy the full SHA
    bd6c65e View commit details
    Browse the repository at this point in the history

Commits on Oct 9, 2023

  1. Improve pipx help message

    Co-authored-by: chrysle <[email protected]>
    peterkuma and chrysle committed Oct 9, 2023
    Configuration menu
    Copy the full SHA
    1c8e08b View commit details
    Browse the repository at this point in the history
  2. Improve pipx help message

    Co-authored-by: chrysle <[email protected]>
    peterkuma and chrysle committed Oct 9, 2023
    Configuration menu
    Copy the full SHA
    0e236ad View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    83f511c View commit details
    Browse the repository at this point in the history
  4. Improve formatting in How pipx works

    Co-authored-by: chrysle <[email protected]>
    peterkuma and chrysle committed Oct 9, 2023
    Configuration menu
    Copy the full SHA
    c7433dc View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    37074fb View commit details
    Browse the repository at this point in the history
  6. Improve pipx inject help message

    Mention that --include-apps also exposes manual pages.
    peterkuma committed Oct 9, 2023
    Configuration menu
    Copy the full SHA
    71cc733 View commit details
    Browse the repository at this point in the history

Commits on Oct 24, 2023

  1. Configuration menu
    Copy the full SHA
    e1d4d5a View commit details
    Browse the repository at this point in the history

Commits on Oct 25, 2023

  1. Fix tests related to man page symlinking

    - pipx output was not correctly parsed now that a list of manual pages is also
      printed.
    - LOCAL_MAN_DIR was not monkey patched. As a result, manual pages were
      installed under ~/.local instead of a temporary directory.
    peterkuma committed Oct 25, 2023
    Configuration menu
    Copy the full SHA
    7662c7a View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    3848b0d View commit details
    Browse the repository at this point in the history
  3. Test for installed manual pages of packages

    For now this is only enabled for the packages pycowsay and youtube-dl.
    peterkuma committed Oct 25, 2023
    Configuration menu
    Copy the full SHA
    4b13f11 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    7451200 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    6200e9c View commit details
    Browse the repository at this point in the history

Commits on Oct 26, 2023

  1. Configuration menu
    Copy the full SHA
    12986d4 View commit details
    Browse the repository at this point in the history
  2. Update tests so that they work with man pages

    Also update remaining pycowsay references to version 0.0.0.2.
    peterkuma committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    e5af3e1 View commit details
    Browse the repository at this point in the history
  3. Fix a lint error

    peterkuma committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    681379c View commit details
    Browse the repository at this point in the history
  4. Make test man page paths OS independent

    This is to fix tests on Windows.
    peterkuma committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    57b72ec View commit details
    Browse the repository at this point in the history
  5. Remove redundant print calls in test_list.py

    These have been introduced accidentaly.
    peterkuma committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    e9de6cc View commit details
    Browse the repository at this point in the history

Commits on Oct 30, 2023

  1. Configuration menu
    Copy the full SHA
    c663de0 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    785e590 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    e92d48d View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    43a5b55 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    ac68fe0 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    4be646c View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    8bfa906 View commit details
    Browse the repository at this point in the history
  8. Fix a code formatting issue

    peterkuma committed Oct 30, 2023
    Configuration menu
    Copy the full SHA
    d3f55df View commit details
    Browse the repository at this point in the history
  9. Configuration menu
    Copy the full SHA
    2f31c96 View commit details
    Browse the repository at this point in the history
  10. Merge main

    peterkuma committed Oct 30, 2023
    Configuration menu
    Copy the full SHA
    d599c0f View commit details
    Browse the repository at this point in the history
  11. Configuration menu
    Copy the full SHA
    1ff0d48 View commit details
    Browse the repository at this point in the history
  12. Configuration menu
    Copy the full SHA
    d9c8843 View commit details
    Browse the repository at this point in the history
  13. Fix code formatting

    peterkuma committed Oct 30, 2023
    Configuration menu
    Copy the full SHA
    2f2eec8 View commit details
    Browse the repository at this point in the history
  14. Fixes in test all packages

    peterkuma committed Oct 30, 2023
    Configuration menu
    Copy the full SHA
    0e81de6 View commit details
    Browse the repository at this point in the history
  15. Fix test package info

    peterkuma committed Oct 30, 2023
    Configuration menu
    Copy the full SHA
    ba7e35e View commit details
    Browse the repository at this point in the history
  16. Fix test package info

    peterkuma committed Oct 30, 2023
    Configuration menu
    Copy the full SHA
    567a86f View commit details
    Browse the repository at this point in the history
  17. Fix code formatting

    peterkuma committed Oct 30, 2023
    Configuration menu
    Copy the full SHA
    d30eae1 View commit details
    Browse the repository at this point in the history

Commits on Oct 31, 2023

  1. Configuration menu
    Copy the full SHA
    9234fd1 View commit details
    Browse the repository at this point in the history
  2. Update test package info

    peterkuma committed Oct 31, 2023
    Configuration menu
    Copy the full SHA
    2b87dae View commit details
    Browse the repository at this point in the history

Commits on Nov 1, 2023

  1. Configuration menu
    Copy the full SHA
    ab391a0 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    16e2e07 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    056ca41 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    3005ae5 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    0ba4a72 View commit details
    Browse the repository at this point in the history

Commits on Nov 2, 2023

  1. Configuration menu
    Copy the full SHA
    31b6301 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    57fc444 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    a357a08 View commit details
    Browse the repository at this point in the history
  4. Update test package lists

    peterkuma committed Nov 2, 2023
    Configuration menu
    Copy the full SHA
    129fa8c View commit details
    Browse the repository at this point in the history
  5. Downgrade cloudtoken to 0.1.707

    2.1.10 fails under macos.
    peterkuma committed Nov 2, 2023
    Configuration menu
    Copy the full SHA
    439f242 View commit details
    Browse the repository at this point in the history
  6. Update test package lists

    peterkuma committed Nov 2, 2023
    Configuration menu
    Copy the full SHA
    019b12f View commit details
    Browse the repository at this point in the history
  7. Fix code formatting issue

    peterkuma committed Nov 2, 2023
    Configuration menu
    Copy the full SHA
    181deac View commit details
    Browse the repository at this point in the history

Commits on Nov 3, 2023

  1. Configuration menu
    Copy the full SHA
    0548974 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    6fdfc24 View commit details
    Browse the repository at this point in the history

Commits on Nov 7, 2023

  1. Configuration menu
    Copy the full SHA
    23cca61 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    4914277 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    d9604da View commit details
    Browse the repository at this point in the history

Commits on Dec 2, 2023

  1. Configuration menu
    Copy the full SHA
    24c5cf7 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    6afa2b0 View commit details
    Browse the repository at this point in the history