You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2020/01/20 18:24:25 UTC
[GitHub] [airflow] JeremyBernier opened a new pull request #7221: Update
installation doc to suggest installing globally as fallback
JeremyBernier opened a new pull request #7221: Update installation doc to suggest installing globally as fallback
URL: https://github.com/apache/airflow/pull/7221
I was having an installation issue on Windows Subsystem for Linux (Ubuntu) where the `airflow` command was not being recognized. I was able to fix this by installing apache-airflow globally with the following command `sudo -H pip install apache-airflow`. Had this been written in the docs, I would've saved myself a lot of wasted time searching Google and StackOverflow for the solution, so I wrote it in the doc as a fallback suggestion.
https://stackoverflow.com/questions/32378494/how-to-run-airflow-on-windows/59828890#59828890
---
Issue link: WILL BE INSERTED BY [boring-cyborg](https://github.com/kaxil/boring-cyborg)
Make sure to mark the boxes below before creating PR: [x]
- [ ] Description above provides context of the change
- [ ] Commit message/PR title starts with `[AIRFLOW-NNNN]`. AIRFLOW-NNNN = JIRA ID<sup>*</sup>
- [ ] Unit tests coverage for changes (not needed for documentation changes)
- [ ] Commits follow "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
- [ ] Relevant documentation is updated including usage instructions.
- [ ] I will engage committers as explained in [Contribution Workflow Example](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#contribution-workflow-example).
<sup>*</sup> For document-only changes commit message can start with `[AIRFLOW-XXXX]`.
---
In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
Read the [Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines) for more information.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] kaxil merged pull request #7221: [AIRFLOW-XXXX] Update
installation doc to suggest installing globally as fallback
Posted by GitBox <gi...@apache.org>.
kaxil merged pull request #7221: [AIRFLOW-XXXX] Update installation doc to suggest installing globally as fallback
URL: https://github.com/apache/airflow/pull/7221
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] kaxil commented on issue #7221: [AIRFLOW-XXXX] Update
installation doc to suggest installing globally as fallback
Posted by GitBox <gi...@apache.org>.
kaxil commented on issue #7221: [AIRFLOW-XXXX] Update installation doc to suggest installing globally as fallback
URL: https://github.com/apache/airflow/pull/7221#issuecomment-578649121
@JeremyBernier - I have updated your PR with https://github.com/apache/airflow/pull/7221/commits/fa52fb426754debd3bd6a7e4dec45014618294ce .
There was a tab on a new line that needed to be removed.
Thanks for your contribution
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] JeremyBernier commented on issue #7221: [AIRFLOW-XXXX]
Update installation doc to suggest installing globally as fallback
Posted by GitBox <gi...@apache.org>.
JeremyBernier commented on issue #7221: [AIRFLOW-XXXX] Update installation doc to suggest installing globally as fallback
URL: https://github.com/apache/airflow/pull/7221#issuecomment-576955664
That's fair. Modified the commit to suggest adding `~/.local/bin` to PATH if `airflow` command isn't recognized. Adding the directory to the path definitely resolves the issue on WSL.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] mik-laj commented on a change in pull request #7221:
[AIRFLOW-XXXX] Update installation doc to suggest installing globally as
fallback
Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #7221: [AIRFLOW-XXXX] Update installation doc to suggest installing globally as fallback
URL: https://github.com/apache/airflow/pull/7221#discussion_r368933069
##########
File path: docs/installation.rst
##########
@@ -28,6 +28,12 @@ The easiest way to install the latest stable version of Airflow is with ``pip``:
.. code-block:: bash
pip install apache-airflow
+
+If the `airflow` command is not being recognized, then install Airflow globally:
Review comment:
Installing airflow globally is very dangerous because Airflow requires a large number of dependencies that may not be compatible with other applications.
```
11:50 $ python
Python 3.6.8 (v3.6.8:3c6b436a57, Dec 24 2018, 02:04:31)
[GCC 4.2.1 Compatible Apple LLVM 6.0 (clang-600.0.57)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import airflow.bin
>>> airflow.bin.__file__
'/Users/kamilbregula/devel/CLIENT-airflow/airflow/airflow/bin/__init__.py'
>>>
KeyboardInterrupt
>>>
KeyboardInterrupt
>>> ^D
11:53 $ export PATH=/Users/kamilbregula/devel/CLIENT-airflow/airflow/airflow/bin:$PATH
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] boring-cyborg[bot] commented on issue #7221:
[AIRFLOW-XXXX] Update installation doc to suggest installing globally as
fallback
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on issue #7221: [AIRFLOW-XXXX] Update installation doc to suggest installing globally as fallback
URL: https://github.com/apache/airflow/pull/7221#issuecomment-578662662
Awesome work, congrats on your first merged pull request!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk commented on a change in pull request #7221:
[AIRFLOW-XXXX] Update installation doc to suggest installing globally as
fallback
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #7221: [AIRFLOW-XXXX] Update installation doc to suggest installing globally as fallback
URL: https://github.com/apache/airflow/pull/7221#discussion_r368941475
##########
File path: docs/installation.rst
##########
@@ -28,6 +28,12 @@ The easiest way to install the latest stable version of Airflow is with ``pip``:
.. code-block:: bash
pip install apache-airflow
+
+If the `airflow` command is not being recognized, then install Airflow globally:
Review comment:
Yes. Agree with @mik-laj . I think a better (and recommended) solution is to add your `${HOME}/.local/bin` to PATH in .profile. I think you hit this bug of WSL: https://github.com/microsoft/WSL/issues/2148 - where the PATH does not include the .local/bin folder. Would it be possible @JeremyBernier that you double check it and update it if you see that it works. We have no WSL/Windows handy ....
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] potiuk commented on issue #7221: [AIRFLOW-XXXX] Update
installation doc to suggest installing globally as fallback
Posted by GitBox <gi...@apache.org>.
potiuk commented on issue #7221: [AIRFLOW-XXXX] Update installation doc to suggest installing globally as fallback
URL: https://github.com/apache/airflow/pull/7221#issuecomment-578560984
@JeremyBernier - some static check/whitespace problems to fix. If you install and run pre-commit as described in STATIC_CHECKS.rst, then pre-commit should solve it for you automatically
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] boring-cyborg[bot] commented on issue #7221: Update
installation doc to suggest installing globally as fallback
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on issue #7221: Update installation doc to suggest installing globally as fallback
URL: https://github.com/apache/airflow/pull/7221#issuecomment-576386590
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
Contribution Guide (https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst)
Here are some useful points:
- Pay attention to the quality of your code (flake8, pylint and type annotations). Our [pre-commits](
https://github.com/apache/airflow/blob/master/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks)
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](https://github
.com/apache/airflow/blob/master/docs/howto/custom-operator.rst) Consider adding an example DAG that shows
how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/master/BREEZE.rst) 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.
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://apache-airflow-slack.herokuapp.com/
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services