Skip to content

README install section is outdated #423

Description

@ekalinin

The Install section of README.rst still describes the setup from the early releases:

  • It leads with sudo easy_install nodeenv. setuptools removed the easy_install command in v80.0.0.

  • The next option is sudo pip install nodeenv. Pythons marked as externally managed (PEP 668), such as Homebrew's and the system Python of Debian 12 and Ubuntu 23.04 or later, refuse it:

    $ python3 -m pip install nodeenv
    error: externally-managed-environment
    
  • The local installation example shows 0.6.5 as the output of nodeenv --version. The current release is 1.11.0.

  • The pip and easy_install links point to http://pypi.python.org/pypi/....

The Dependency section right below says python (2.6+, 3.5+, or pypy), while setup.py has python_requires=">=2.7,!=3.0.*,...,!=3.6.*", that is 2.7 or 3.7+.

Possible fix

Lead with pipx install nodeenv for a global install and pip install nodeenv inside a virtualenv, drop easy_install and sudo, remove the version output from the example, and align the Dependency section with python_requires.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation changes

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions