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

Update PythonVirtualenvOperator Howto #24782

Merged
merged 2 commits into from Jul 7, 2022

Conversation

nanohanno
Copy link
Contributor

@nanohanno nanohanno commented Jul 1, 2022

Currently, there is no hint in the documentation that the virtualenv package needs to be installed in the host environment when using PythonVirtualenvOperator. There is an exception raised when it is not the case but I would have found it good to find the requirement already in its documentation. This PR brings a description as a change.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragement file, named {pr_number}.significant.rst, in newsfragments.

@boring-cyborg boring-cyborg bot added area:core-operators Operators, Sensors and hooks within Core Airflow kind:documentation labels Jul 1, 2022
@boring-cyborg
Copy link

boring-cyborg bot commented Jul 1, 2022

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/main/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (flake8, 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.
    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

@uranusjr
Copy link
Member

uranusjr commented Jul 4, 2022

We should mention apache-airflow[virtualenv] somewhere (which is meant for this).

@nanohanno nanohanno requested a review from potiuk July 4, 2022 08:20
@nanohanno
Copy link
Contributor Author

We should mention apache-airflow[virtualenv] somewhere (which is meant for this).

It is mentioned in the change, do you suggest to mention in another part of the documentation as well?

@potiuk potiuk force-pushed the hk-virtualenvoperator-docs branch from 70caa5f to d391d93 Compare July 6, 2022 22:36
@eladkal eladkal added this to the Airflow 2.3.4 milestone Jul 7, 2022
@eladkal eladkal added the type:doc-only Changelog: Doc Only label Jul 7, 2022
@potiuk potiuk merged commit 011fbae into apache:main Jul 7, 2022
@boring-cyborg
Copy link

boring-cyborg bot commented Jul 7, 2022

Awesome work, congrats on your first merged pull request!

@nanohanno nanohanno deleted the hk-virtualenvoperator-docs branch July 7, 2022 19:37
ephraimbuddy pushed a commit that referenced this pull request Aug 15, 2022
* Update PythonVirtualenvOperator Howto

(cherry picked from commit 011fbae)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:core-operators Operators, Sensors and hooks within Core Airflow kind:documentation type:doc-only Changelog: Doc Only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants