Update pypi installation files, readme type, and pytest args #120
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Håkon Wiik Ånes hwaanes@gmail.com
Description
This PR attempts to fix which files are installed to
site-packages/kikuchipy
when installing frompip
(i.e., either from the source distribution,.tar.gz
, or the binary distribution,wheel
).I've updated the
setup.py
attributepackage_data
which, to my limited knowledge with Python package distribution, dictates which files are installed (not just uploaded to PyPI) when callingpip install kikuchipy
. I've also updated theMANIFEST.in
, which I thought did whatpackage_data
apparently does, to include all files in the repo, except the "hidden" files. Thus, the documentation is included in the source distribution.Type of change
References
I've tried to understand
package_data
by reading these resources:I hope this will fix #119, and hopefully fix the failing tests in my PR to
conda-forge/staged-recipies
(conda-forge/staged-recipes#10523).How has this been tested?
site-packages/kikuchipy
when packaging withpython setup.py sdist bdist_wheel
and installing from both the built tarball and wheelsite-packages/kikuchipy
when packaging, uploading to https://test.pypi.org/project/kikuchipy/, and then installing from both the source and binary distributionsFinal checklist:
- [ ] I have added tests that prove my fix is effective or that my feature works