build: Add Pipenv for dependency management

[jordan-gillard]

Summary

This PR adds Pipenv for improved dependency management.

Rationale

1. Pipenv automatically creates and manages virtual environments.
2. The Pipfile.lock file locks dependencies to ensure consistent dependencies across environments, reducing "it works on my machine" issues.
3. Pipenv enhances project security by checking for known dependency vulnerabilities.
4. Pipfile is more readable and clear compared to requirements.txt, it also has a really neat [scripts] section.
5. Pipenv distinctly separates development and production dependencies. This will make developers who want to work on this project & users who want to install from PyPI live's easier.
6. Last but not least it's endorsed by the Python Packaging Authority.

I would like to make some enhancements to this project (like adding tests - #11), which would require installing pytest. I don't want to make pytest a production dependency. Users who just want to use the script shouldn't have to install it. So I decided a good first step to enhancing EDGAR is to add a nicer dependency manager. Users can still use requirements.txt for the original workflow. In the future developers can generate requirements.txt via pipenv requirements > requirements.txt.

Pipenv is great. Another alternative is Poetry. Please lmk if you would like further explanation/justification for this PR.

[GalenReich]

I didn't spot this PR before merging #10, but in general am very much in favour of adding better dependency management 🙌

[jordan-gillard]

I didn't spot this PR before merging #10, but in general am very much in favour of adding better dependency management 🙌

@GalenReich Rad. I'll refactor this to account for the latest changes. Probably not until Wednesday tho 🙂

[jordan-gillard]

@GalenReich lmk what you think.

Edit: I saw last night that other Bellingcat Python projects use Poetry. Would you prefer that? It's no big

[GalenReich]

This looks great! 🙌 Thanks for sorting this - it'll be much more reliable I'm sure! No worries about using pipenv over poetry, we have a mix of projects using each. Just the one open question about installing the dev dependencies.

[GalenReich]

Should this be pipenv install --dev? As otherwise black is not installed.

[jordan-gillard]

Good eye. Yes, you are correct. Addressed here: 93bc4b1

[GalenReich]

Looks good to me!