search

jdrumgoole / gdelttools

Scripts to load the GDELT data set into MongoDB
Apache License 2.0
7 stars 6 forks source link

README improvements #2

Closed stennie closed 2 years ago

stennie commented 2 years ago

Some improvements based on trying to follow the README to get started.

webchick commented 2 years ago

Oh, this is very helpful! I like that we don't assume people don't what the heck pip / pipenv are and how to use them. 👍

One quick suggestion: I like how you explicitly tell people how to install using pip, can we do the same for pipenv? Like:

To install GDELT Tools using pipenv:

    pipenv install Pipfile

(I assume? This seemed to do something for me, anyway. :D)

And then [whatever you're supposed to do with pipenv shell].

And then, just a question: is pip3 / python3 the proper way to do things, even on modern machines? It feels so clunky. ;( I ended up following the instructions here https://opensource.com/article/19/5/python-3-default-mac to make it just regular "python" and "pip."

stennie commented 2 years ago

I like how you explicitly tell people how to install using pip, can we do the same for pipenv?

This is already in the README under "Install requirements using Pipenv (recommended)". You first need to install pipenv, and can then run pipenv install(which defaults to usingPipfile, if found in the current directory.

is pip3 / python3 the proper way to do things, even on modern machines?

Unfortunately, yes. The main challenge is that macOS prior to Monterey still ships with Python 2.7 as the system default Python. If you install Python 3 but do not have it as the default in your path, python will be Python 2.7. PEP 394 ensures that python3 and pip3 are referring to Python 3.

We could add more info here, like checking the output of python --version and which python, but the simplest fix that I've learned from maintaining other Python tools is to recommend python3 and pip3.

If your default Python is indeed Python 3, python and pip will do the right thing. However, python3 and pip3 should always have the expected outcome.

webchick commented 2 years ago

Oh, nice! In that case, LGTM. 👍

jdrumgoole commented 2 years ago

The right answer is to build a proper python package. I will do that next week.

On Sat 16 Apr 2022, 1:56 AM Angie Byron, @.***> wrote:

Oh, nice! In that case, LGTM. 👍

— Reply to this email directly, view it on GitHub https://github.com/jdrumgoole/gdelttools/pull/2#issuecomment-1100491082, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAXYDTMZGU34DBWMGCIPCLVFIF4DANCNFSM5TPPBKWQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>

jdrumgoole commented 2 years ago

I think most of these issues are fixed with the latest release Stennie. Can you give it a spin?

https://pypi.org/project/gdelttools/