Licensing, data source fix, README and update for new Python#28
Open
MiranDaniel wants to merge 1 commit intoTripSit:masterfrom
Open
Licensing, data source fix, README and update for new Python#28MiranDaniel wants to merge 1 commit intoTripSit:masterfrom
MiranDaniel wants to merge 1 commit intoTripSit:masterfrom
Conversation
Author
|
Sorry for making such a complex PR, let me know if you'd like me to split it into multiple smaller ones per-issue. |
Author
|
Tiny question: How do you version this project? Will this PR be version 5.1.0? |
This file contains hidden or 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
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.
Licensing
Based on our previous discussion I have added licensing information to the project and the result images/PDFs.
I suggest the
PolyForm Noncommercial License 1.0.0license for the code andCreative Commons Attribution Non Commercial Share Alike 4.0 Internationalfor the results.I have also added the license info into the chart itself right below the version/generation date.
README changes
New Python versions do not allow installing packages globally with
pipand using avenvis recommended.I have created a
requirements.txtfile that lists all the requirements and updated the README to match the new setup/usage guide.Also decided to add a general footer to explain what the project is/what it does. Example image included!
Footer change
I have decided to add the date of the last combo data update to the footer right next to the generation date. Should make it more obvious to notice old data when generating.
Data source URL change
The old URL (https://github.com/TripSit/drugs/blob/main/combos.json) now returns the HTML page instead of raw JSON. My patch uses the raw file GitHub API instead. The data is still taken from the combos.json file on TripSit/drugs, the only thing that changed is the API used to access it.