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

[UP][m] Updating the scripts with v2 source of world bank #3

Merged
merged 5 commits into from
Dec 3, 2024
Merged

Conversation

gradedSystem
Copy link
Member

Changes made

  • Updated the scripts to update the archive and data folders
  • Updated requirements.txt
  • Small README.md update

cc @anuveyatsu

@Mikanebu Mikanebu self-requested a review December 3, 2024 12:13
Copy link
Member

@Mikanebu Mikanebu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @gradedSystem ! Nice work, but lets remove this README in scripts and merge it into README in root directory, all the contents move to Preparation section as in https://github.com/datasets/currency-codes. Also include how to run make file as in your github actions. Lets make a same structure. Also please remove some unnecessary headings such as Usage of process.py and Tags and committing changes and make it simple and easy to read.

@gradedSystem gradedSystem requested a review from Mikanebu December 3, 2024 12:39
@gradedSystem
Copy link
Member Author

@Mikanebu done

README.md Outdated
but please follow [OKFN's curator guide](http://data.okfn.org/doc/core-data-curators)
to keep things as organized as possible.

## Tags and committing changes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this pls

README.md Outdated

## License

All data is licensed under the Open Data Commons Public Domain Dedication and License. All code is licensed under the MIT/BSD license.

Note that while no credit is formally required a link back or credit to Rufus Pollock and the Open Knowledge Foundation is much appreciated.


## Contributing
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also this one, since that url is not valid anymore

README.md Outdated
@@ -7,9 +7,40 @@ The repository of the data package of the GINI Index.
The data that is contained in the `gini-index.csv` file, under `/data` was
retrieved from [the World Bank](http://data.worldbank.org/indicator/SI.POV.GINI).

## Requirements
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one should be Preparation section and add some sentence on how to run scripts

README.md Outdated
run the script.

`pip install -r scripts/requirements.txt`


## License
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before the license, add Automation section as in https://github.com/datasets/gdp

@gradedSystem gradedSystem requested a review from Mikanebu December 3, 2024 12:59
Run the requirements through `pip` in order to install all required packages to
run the script.

`pip install -r scripts/requirements.txt`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

after this add how to run script for example:

Process is recorded and automated in python script:
scripts/process.py

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done @Mikanebu

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update to make pls

Copy link
Member

@Mikanebu Mikanebu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, add how to run script in Preparation section

@gradedSystem gradedSystem requested a review from Mikanebu December 3, 2024 13:05
Copy link
Member

@Mikanebu Mikanebu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In your actions, it is make to run script?

@gradedSystem
Copy link
Member Author

@Mikanebu Yes it is

@Mikanebu
Copy link
Member

Mikanebu commented Dec 3, 2024

@gradedSystem Pls, update then accordingly.

@gradedSystem gradedSystem requested a review from Mikanebu December 3, 2024 13:15
Copy link
Member

@Mikanebu Mikanebu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@Mikanebu Mikanebu merged commit 8f5f419 into main Dec 3, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants