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 2019/06/02 21:13:53 UTC

[GitHub] [airflow] BasPH opened a new pull request #5363: [AIRFLOW-4725] Fix setup.py PEP440 & Sphinx-PyPI-upload dependency

BasPH opened a new pull request #5363: [AIRFLOW-4725] Fix setup.py PEP440 & Sphinx-PyPI-upload dependency
URL: https://github.com/apache/airflow/pull/5363
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
     - https://issues.apache.org/jira/browse/AIRFLOW-XXX
     - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
     - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
     - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   
   ### Description
   
   - [ ] Here are some details about my PR, including screenshots of any UI changes:
   
   In this PR I make 3 improvements to setup.py:
   
   1. It doesn't throw a warning "UserWarning: The version specified ('2.0.0.dev0+') is an invalid version, this may not work as expected with newer versions of setuptools, pip, and PyPI. Please see PEP 440 for more details."
   
   Newer versions of setuptools expect PEP440 versioning and our version `2.0.0.dev0+` does not comply to that. Removed the + and now it is.
   
   2. It fixes the Sphinx-PyPI-upload dependency which was making setup.py crash when running "python setup.py --help-commands".
   
   Running `python setup.py --help-commands` crashes setup.py (testing with Python 3.5 and 3.6):
   
   ```
   ...
   airflow/lib/python3.6/site-packages/sphinx_pypi_upload.py", line 61
       raise DistutilsOptionError, \
   ```
   
   Found [this thread](https://bitbucket.org/jezdez/sphinx-pypi-upload/issues/4/syntax-error-in-python-33) and appears to be related to the super old Sphinx-PyPI-upload version we're using. Updated to Sphinx-PyPI-upload3 with newer version and no more crash.
   
   3. And it adds descriptions for the custom commands.
   
   The custom commands now display descriptions:
   
   ```
   python setup.py --help-commands
   ...
   Extra commands:
     extra_clean       Tidy up the project root
     compile_assets    Compile and build the frontend assets
   ```
   
   ### Tests
   
   - [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   
   ### Commits
   
   - [ ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [ ] In case of new functionality, my PR adds documentation that describes how to use it.
     - All the public functions and the classes in the PR contain docstrings that explain what it does
     - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
   
   ### Code Quality
   
   - [ ] Passes `flake8`
   

----------------------------------------------------------------
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