Restrcture for PyPI and update documentation #31
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The Python package `taswira` has now been moved to the root of the repository. The continous integration GitHub Action has also been update accordingly. Signed-off-by: Abhineet Tamrakar <abhineet97@gmail.com>
This structure has many benifits as outlined here https://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure Signed-off-by: Abhineet Tamrakar <abhineet97@gmail.com>
This commit adds all the necessary files so that the module can be uploaded to PyPI. Due to limitations in flit, I've decided to remove it and adopt the traditional setuptools based approach instead. Signed-off-by: Abhineet Tamrakar <abhineet97@gmail.com>
Signed-off-by: Abhineet Tamrakar <abhineet97@gmail.com>
Signed-off-by: Abhineet Tamrakar <abhineet97@gmail.com>
abhineet97
added
the
gsoc2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
It seems that the Rasterio wheels that are available of PyPI do not support ZSTD. Sadly, without that, it would not make sense to publish Taswira on PyPI, so we'll have to hold that for now. Anyways, I've restructured the project and have added all the necessary files required to publish the package on PyPI. I've done this to make sure that in the future when Rasterio adds support for ZSTD in its PyPI wheel, we'll be able to quickly publish Taswira.
Apart from that I've also updated the README with all the necessary usage information (along with some shiny badges and a screenshot). Let me know if it needs more improvement.
Fixes #30
How Has This Been Tested?
Using unit-tests and manual tests
Checklist: