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

Mac OS installation guide references requirements.txt but not seeing file in download #3197

Closed
eljeffeg opened this issue Aug 16, 2020 · 3 comments
Assignees
Labels
deployment Changes to deployment or development utility scripts documentation Issues relating to documentation MacOS Issue related to MacOS question

Comments

@eljeffeg
Copy link

eljeffeg commented Aug 16, 2020

MacOS install says this:

Install the Plaso dependencies:

cd /tmp/plaso-20200430/
pip install -r requirements.txt

But there is no requirements.txt, just a dependencies.ini, which I have no idea how to reference with pip.

@joachimmetz joachimmetz added question documentation Issues relating to documentation labels Aug 16, 2020
@joachimmetz
Copy link
Member

joachimmetz commented Aug 16, 2020

You likely downloaded the wrong file:

Under the latest release you should see four links to different packages, you will need to download the “Source code (tar.gz)” package file

Please don't use pip if you're not familiar with it. It can be easy to mess up your installation with. I recommend using the Docker build instead.

@joachimmetz joachimmetz self-assigned this Aug 16, 2020
@joachimmetz joachimmetz changed the title requirements.txt in Docs, but no file Mac OS installation guide references requirements.txt but not seeing file in download Aug 16, 2020
@joachimmetz joachimmetz added MacOS Issue related to MacOS deployment Changes to deployment or development utility scripts labels Aug 16, 2020
@eljeffeg
Copy link
Author

eljeffeg commented Aug 16, 2020

Thanks, I did download the wrong package. The documentation could still be updated. While it says to download the source code, the instructions reference the other package, so it's not entirely clear that the other package doesn't include the needed file to install the dependencies. Aside from that one file, everything else worked, so why not include it?

cd /tmp
tar zxf ~/Downloads/plaso-20200430.tar.gz

I'm familiar with pip, which is why I didn't understand the dependencies.ini (expecting the -r requirements.txt), but Docker is definitely the easier way to go.

@joachimmetz
Copy link
Member

joachimmetz commented Aug 16, 2020

Aside from that one file, everything else worked, so why not include it?

To prevent people messing up their installations with pip or having broken build environments and the time it takes to help troubleshoot them.

dependencies.ini is a project specific configuration file to generate files that define dependencies, like requirements.txt.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deployment Changes to deployment or development utility scripts documentation Issues relating to documentation MacOS Issue related to MacOS question
Projects
None yet
Development

No branches or pull requests

2 participants