pyenv / pyenv/pyenv

Improvement: Follow XDG config spec

Open
#1,789 7 comments 37 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: enhancement
Dominant language
Shell
Stars
45.1k
Forks
3.3k
Avg merge
19h 54m
Merged PRs (30d)
21

Description

An old issus was closed regarding XDG: https://github.com/pyenv/pyenv/issues/139 - but that was 7 years ago now. Since then the XDG spec have become much more predominant. Many common tools follow it.

This issue is created to re-evaluate where pyenv is installed by default, using the XDG config and data dirs as appropriate. This gives a cleaner home directory for users, and users will also know that files placed in $XDG_CONFIG_HOME or the default $HOME/.config, are files that I as a user can manually update. And then also sync via dotfiles between machines, if wanted.

Prerequisite
  • [ x] Make sure your problem is not listed in the common build problems.
  • [ x] Make sure no duplicated issue has already been reported in the pyenv issues. You should look for closed issues, too.
  • [x ] Make sure you are not asking us to help solving your specific issue.
    • GitHub issues is opened mainly for development purposes. If you want to ask someone to help solving your problem, go to some community site like Gitter, StackOverflow, etc.
  • [x ] Make sure your problem is not derived from packaging (e.g. Homebrew).
    • Please refer to the package documentation for the installation issues, etc.
  • [x ] Make sure your problem is not derived from plugins.
    • This repository is maintaining pyenv and the default python-build plugin only. Please refrain from reporting issues of other plugins here.
Description
  • [ x] Platform information (e.g. Ubuntu Linux 16.04): Ubuntu 20.04
  • [ x] OS architecture (e.g. amd64): amd64
  • [ x] pyenv version: 1.2.22
  • [ x] Python version: 3.8.7
  • [ x] C Compiler information (e.g. gcc 7.3): 9.3
  • Please attach verbose build log as gist
    • You can turn on verbose debug logging using by setting PYENV_DEBUG=1, e.g. env PYENV_DEBUG=1 pyenv install -v 3.6.4

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by reviewing the prior issue #139 and the linked XDG Base Directory specification, then determine which pyenv installation, configuration, and data locations should change and how existing users are handled; done requires an agreed, implementable scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.