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

[QUESTION] Check validity of setup.py in build #2446

Closed
dhermes opened this issue Sep 27, 2016 · 3 comments
Closed

[QUESTION] Check validity of setup.py in build #2446

dhermes opened this issue Sep 27, 2016 · 3 comments
Assignees
Labels
type: question Request for information or clarification. Not an issue.

Comments

@dhermes
Copy link
Contributor

dhermes commented Sep 27, 2016

H/T to http://inre.dundeemt.com/2014-05-17/pypi-setup-py-keeping-a-dry-long_description/ (I was Googling around for DRY in setup.py)

python setup.py check --restructuredtext --strict

For example, running it on the post #2442 version gives:

$ python setup.py check --restructuredtext --strict
running check
warning: check: Duplicate implicit target name: "contributing".

warning: check: Duplicate implicit target name: "license".

error: Please correct your package.

because we have sections named license and contributing as well as links with those names. This could be fixed via

diff --git a/README.rst b/README.rst
index 715368b..bbf0f72 100644
--- a/README.rst
+++ b/README.rst
@@ -96,16 +96,16 @@ Contributing

 Contributions to this library are always welcome and highly encouraged.

-See `CONTRIBUTING`_ for more information on how to get started.
+`See CONTRIBUTING`_ for more information on how to get started.

-.. _CONTRIBUTING: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/CONTRIBUTING.rst
+.. _See CONTRIBUTING: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/CONTRIBUTING.rst

 License
 -------

-Apache 2.0 - See `LICENSE`_ for more information.
+Apache 2.0 - `See LICENSE`_ for more information.

-.. _LICENSE: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/LICENSE
+.. _See LICENSE: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/LICENSE

 .. |build| image:: https://travis-ci.org/GoogleCloudPlatform/google-cloud-python.svg?branch=master
    :target: https://travis-ci.org/GoogleCloudPlatform/google-cloud-python
@dhermes dhermes added type: question Request for information or clarification. Not an issue. build labels Sep 27, 2016
@theacodes
Copy link
Contributor

We should do this. Google-auth does it.

@theacodes theacodes reopened this Apr 19, 2017
@dhermes
Copy link
Contributor Author

dhermes commented Apr 19, 2017

@jonparrott Jinx! I'm going to send a PR for adding this to nox -e lint for the subpackages. Should I add a nox -e lint for the top-level package?

@lukesneeringer
Copy link
Contributor

I would prefer it be a separate nox session if possible.

dhermes added a commit to dhermes/google-cloud-python that referenced this issue Apr 20, 2017
dhermes added a commit that referenced this issue Apr 20, 2017
* Adding check that **all** setup.py README's are valid RST.

Follow up to #3316. Fixes #2446.

* Fixing duplicate reference in Logging README.

* Fixing duplicate reference in Monitoring README.
richkadel pushed a commit to richkadel/google-cloud-python that referenced this issue May 6, 2017
…s#3318)

* Adding check that **all** setup.py README's are valid RST.

Follow up to googleapis#3316. Fixes googleapis#2446.

* Fixing duplicate reference in Logging README.

* Fixing duplicate reference in Monitoring README.
atulep pushed a commit that referenced this issue Apr 3, 2023
* Adding check that **all** setup.py README's are valid RST.

Follow up to #3316. Fixes #2446.

* Fixing duplicate reference in Logging README.

* Fixing duplicate reference in Monitoring README.
atulep pushed a commit that referenced this issue Apr 18, 2023
* Adding check that **all** setup.py README's are valid RST.

Follow up to #3316. Fixes #2446.

* Fixing duplicate reference in Logging README.

* Fixing duplicate reference in Monitoring README.
parthea pushed a commit that referenced this issue Jun 4, 2023
* Adding check that **all** setup.py README's are valid RST.

Follow up to #3316. Fixes #2446.

* Fixing duplicate reference in Logging README.

* Fixing duplicate reference in Monitoring README.
parthea pushed a commit that referenced this issue Jul 6, 2023
* Adding check that **all** setup.py README's are valid RST.

Follow up to #3316. Fixes #2446.

* Fixing duplicate reference in Logging README.

* Fixing duplicate reference in Monitoring README.
parthea pushed a commit that referenced this issue Oct 21, 2023
* Adding check that **all** setup.py README's are valid RST.

Follow up to #3316. Fixes #2446.

* Fixing duplicate reference in Logging README.

* Fixing duplicate reference in Monitoring README.
parthea pushed a commit that referenced this issue Oct 21, 2023
* Adding check that **all** setup.py README's are valid RST.

Follow up to #3316. Fixes #2446.

* Fixing duplicate reference in Logging README.

* Fixing duplicate reference in Monitoring README.
parthea pushed a commit that referenced this issue Oct 21, 2023
* Adding check that **all** setup.py README's are valid RST.

Follow up to #3316. Fixes #2446.

* Fixing duplicate reference in Logging README.

* Fixing duplicate reference in Monitoring README.
parthea pushed a commit that referenced this issue Oct 22, 2023
* Adding check that **all** setup.py README's are valid RST.

Follow up to #3316. Fixes #2446.

* Fixing duplicate reference in Logging README.

* Fixing duplicate reference in Monitoring README.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: question Request for information or clarification. Not an issue.
Projects
None yet
Development

No branches or pull requests

5 participants