Readme Update

[hamad-tariq]

The PyPI installation command was not working when I tried to install Apache Airflow on my local machine with the given bash command.

Error Message

At line:2 char:4
+  --constraint "https://raw.githubusercontent.com/apache/airflow/const ...
+    ~
Missing expression after unary operator '--'.
At line:2 char:4
+  --constraint "https://raw.githubusercontent.com/apache/airflow/const ...
+    ~~~~~~~~~~
Unexpected token 'constraint' in expression or statement.
    + CategoryInfo          : ParserError: (:) [], ParentContainsErrorRecordException
    + FullyQualifiedErrorId : MissingExpressionAfterOperator

Solution

Updated the bash command to be executed in a single line.

Old

pip install 'apache-airflow==2.8.2' \
>>  --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-2.8.2/constraints-3.8.txt"

New

pip install 'apache-airflow==2.8.2' --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-2.8.2/constraints-3.8.txt"

[boring-cyborg]

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

• Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
• In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
• Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
• Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
• Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
• Be sure to read the Airflow Coding style.
• Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
  Apache Airflow is a community-driven project and together we are making it better 🚀.
  In case of doubts contact the developers at:
  Mailing List: dev@airflow.apache.org
  Slack: https://s.apache.org/airflow-slack

[dirrao]

This is working as expected. However, you might have added additional space after \ causing the problem.

[Taragolis]

I only know such a problem into the PowerShell. Most possible @hamad-tariq tried to install Airflow on Windows Host. Am I right? If so, I want to mention that there is no official support of Windows yet (and no plan in foreseeable future), see: #10388

[potiuk]

yes sounds isolated. Let's leave it as is

[jedcunningham]

Yep, I agree, let's leave it as is.

I'm going to close this PR now, but thanks @hamad-tariq. I hope to see more docs PRs from you 👍

[hamad-tariq]

Thanks @jedcunningham for the appreciation.

[hamad-tariq]

As per my experience, I had tried the existing command multiple times with the \ but it only worked when I removed the \ . So I decided to correct it up for others so that they can directly use the given command on the Windows CLI and not run with any errors as I did. However, It'll be great if we can add both the commands with clear instructions of when to use which one of them so that if someone faces an error or problem they have the can find a solution right away with in the official documentation.

[potiuk]

Yes. If you can propose a description of that kind, that is a better PR.

[potiuk]

You just need to make sure you describe the right circumstances and explain what's going on - and you are likely the best person to do it.

[hamad-tariq]

Yes I guess that's a better approach to expand the content of the documentation than replacing something in the it. Thanks to all the members for the feedback.