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

fix: correct pip install syntax for dev and doc extras #2457

Merged
merged 3 commits into from
Jan 4, 2025

Conversation

savvar9991
Copy link
Contributor

@savvar9991 savvar9991 commented Jan 4, 2025

1. Developer Dependencies Installation:

-pip install -e .'[dev]'
+pip install -e .[dev]

2.Documentation Tools Installation:

-pip install -e .'[doc]'
+pip install -e .[doc]

Reasons for changes:
The old version with quotes and dot (.'[dev]' or .'[doc]') could lead to installation errors as pip would incorrectly interpret the package path
The new version (.[ ]) is the standard pip syntax for specifying additional dependencies (extras)
This format is the widely accepted and documented way to install packages with extra dependencies
These changes make the installation commands correct and ensure their proper execution.

CONTRIBUTING.md Outdated
@@ -12,7 +12,7 @@ python3 -m venv venv
source venv/bin/activate

# install the developer dependencies (-e is editable mode)
pip install -e .'[dev]'
pip install -e . [dev]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Standard syntax is with no space between them

fubuloubu
fubuloubu previously approved these changes Jan 4, 2025
@fubuloubu fubuloubu enabled auto-merge (squash) January 4, 2025 15:08
@fubuloubu fubuloubu disabled auto-merge January 4, 2025 15:08
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@fubuloubu fubuloubu enabled auto-merge (squash) January 4, 2025 15:10
@fubuloubu fubuloubu merged commit 617885a into ApeWorX:main Jan 4, 2025
18 checks passed
@antazoey
Copy link
Member

antazoey commented Jan 6, 2025

Note for zsh users, you will still need to include the quotes:

(apedev13) ➜  ape git:(main) pip install -e .[doc]
zsh: no matches found: .[doc]
(apedev13) ➜  ape git:(main) pip install -e .'[doc]'
Obtaining file:///Users/antazoey/PythonProjects/ape
  Installing build dependencies ... done
  ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants