Comments (7)
@carljm it would be nice to a have a default cow-path, so that you don't need to write redundant strings in CONTRIBUTING.rst file for all python packages.
from sampleproject.
IMO, this is a setuptools bug. The setup.py test
command is implemented by setuptools, but in this case there are no tests (more precisely, no tests in a place that setuptools expects to find them).
Maybe setuptools should do something to say it ran no tests? I don't know.
We could add instructions on how to run the tests to the project instructions, I guess. But as we don't want to dictate what test runner to use, these would need to be generic "Please put instructions on how to run your tests here". And I'm not sure where those instructions should go. Ironically, I would have put them in README.rst
, but as we recently changed to use README.rst
for the long description, that's not really appropriate any more... Suggestions welcome :-)
from sampleproject.
It is common to put such instructions (which are relevant to contributors, but not necessarily to users) in a CONTRIBUTING.rst
file. As a bonus, GitHub will prominently display a link to this file, if it exists, anytime someone creates a pull request against the project.
from sampleproject.
Since pfmoore said it is an setuptools issue, I create one: https://bitbucket.org/pypa/setuptools/issues/446/setuppy-test-says-it-runs-tests-but-it
from sampleproject.
@guettli Are you suggesting that sampleproject should have a stock CONTRIBUTING.rst
in it? That wouldn't bother me at all.
from sampleproject.
No, adding CONTRIBUTING.rst was not my suggestion. With "redundant strings" I mean this:
If there is one common way how to run tests of a package this need to documented this once in the packaging guide.
Since there is not common way yet, there are N document strings explaining how to run tests. Pypi hosts 67k packages. This makes (in theory) 67k times an explanation how to test a package.
I don't care about the wasted bytes. I care about the wasted time to write and read it. It makes me sad. Really, call my crazy, but I have small tear in my eye. Why is there no agreement?
from sampleproject.
In setuptools the issue is accepted and nearly solved. I close this one here.
See https://bitbucket.org/pypa/setuptools/issues/446/setuppy-test-says-it-runs-tests-but-it
from sampleproject.
Related Issues (20)
- UnicodeDecodeError: 'charmap' codec can't decode byte 0x81 in position 3342: character maps to <undefined> HOT 1
- packet queue is empty, aborting HOT 2
- How do you test this? HOT 2
- Tools
- How to include non python configuration files HOT 1
- How to control spelling incorrection even if phonetically sound same HOT 1
- pyproject.toml: references a "python_requires" key that does not exist HOT 2
- help! Executing file is not working HOT 2
- sampleproject doesn't include files `setup.py` and `setup.cfg` (and maybe other) one of the latest published guides claims it should have HOT 1
- Unclear description of "readme" field in pyproject.toml HOT 2
- The package name HOT 3
- TypeError: unhashable type: 'dict' HOT 4
- Should development dependencies be included in the optional section?
- Error in documentation regarding Packaging and Distributing projects using Setuptools
- Stop advertising adding `wheel` as an unconditional PEP 517 build dependency HOT 6
- Should PyPUG editors have access to this project? HOT 3
- Remove Python version 3.7 to unblock tests HOT 1
- Update tox version? And tox best practices? HOT 2
- Sample build breaks if LICENSE.txt file contains GPL2 license text (containing 0x0c) HOT 13
- Flake8 configuration should not use select
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sampleproject.