Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

README install section is outdated

Open Beginner friendly
  • Is something wrong?
#423 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Start with the Install and Dependency sections in README.rst, then compare the stated Python versions with python_requires in setup.py. Update the installation guidance, remove the obsolete version output and links, and make the dependency text match setup.py; verify that the README no longer recommends easy_install or sudo pip.

Written by the indexing model from the issue text.

Description

docs

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.

Dominant language
Python
Stars
1.8k
Forks
224
Avg merge
10h 15m
Merged PRs (30d)
22

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from ekalinin/nodeenv

All issues in ekalinin/nodeenv

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.