zcutlip / prefsniff

A utility to sniff preferences changes to macOS plist files
MIT License
242 stars 6 forks source link

Update installation instructions to install from PyPI via `pip` #2

Closed hisaac closed 1 year ago

hisaac commented 1 year ago

I'm excited to try this out!

I cloned the repo, but as someone who isn't very familiar with Python, it took me a while to figure out how to run this πŸ˜….

I followed the "Installing" section of the README, but wasn't sure what to do after that. I tried running both ./scripts/build.sh and python ./prefsniff/prefsniff.py, but both got errors.

Eventually, after some googling, I found this Stack Overflow comment which recommended running pip install ., and that did the trick!

Would it be reasonable to change the "Installing" section to say pip install . instead of pip install -r requirements.txt?

hisaac commented 1 year ago

Also, I did get one warning when running pip install .:

DEPRECATION: prefsniff is being installed using the legacy 'setup.py install' method, because it does not have a 'pyproject.toml' and the 'wheel' package is not installed. pip 23.1 will enforce this behaviour change. A possible replacement is to enable the '--use-pep517' option. Discussion can be found at https://github.com/pypa/pip/issues/8559

Not sure if that's an issue, but just an FYI.

clanger9 commented 1 year ago

Thank you for this. pip install . worked for me

zcutlip commented 1 year ago

Thanks for the issue! Good catch on the installation instructions. I need to update the documentation. I'm glad you were able to get going in spite of it.

The preferred method of install, which I will appropriately document soon, is just to install from PyPI, rather than cloning the project:

pip3 install prefsniff should pull the package and any dependencies down from PyPI.

zcutlip commented 1 year ago

Also, I did get one warning when running pip install .:

DEPRECATION: prefsniff is being installed using the legacy 'setup.py install' method, because it does not have a 'pyproject.toml' and the 'wheel' package is not installed. pip 23.1 will enforce this behaviour change. A possible replacement is to enable the '--use-pep517' option. Discussion can be found at pypa/pip#8559

Not sure if that's an issue, but just an FYI.

Thanks for the feedback. I'd never tested without wheel installed since it's one of the first packages I install. I'll see if I can add it to the requirements so it gets installed automatically

hisaac commented 1 year ago

pip3 install prefsniff should pull the package and any dependencies down from PyPI.

Oh nice! Even better than my method. Thank you.

zcutlip commented 1 year ago

README is updated as well as some minor repository & code cleanup. You can now install/upgrade v0.2.2 from PyPI:

$ pip3 install --upgrade [--user] prefsniff

Readme available here as well as on PyPI: https://pypi.org/project/prefsniff/

Note, that I've also replaced the master branch with main, so if you want to continue working with your local git repo, you need to update to the new branch (or re-clone the repository):

$ git checkout master
$ git branch -m master main
$ git fetch origin
$ git branch -u origin/main main
$ git remote set-head origin -a
zcutlip commented 1 year ago

Closing this issue. Feel free to open further issues if you encounter any problems.

Thank you again!

2rbo87 commented 1 year ago

Π’ΠΎΠ·Π½ΠΈΠΊΠ»ΠΎ ΠΈΡΠΊΠ»ΡŽΡ‡Π΅Π½ΠΈΠ΅: ImportError cannot import name 'username' from 'data' (/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/data/init.py) File "/Users/andrewturbin/Desktop/INSTAGRAM/Накрутка Π»Π°ΠΉΠΊΠΎΠ² ΠΏΠΎ всСм Ρ„ΠΎΡ‚ΠΊΠ°ΠΌ Π½Π° страницС/Накрутка подписчиков.py", line 3, in from data import username, password

zcutlip commented 1 year ago

I'm not sure this has anything to do with prefsniff, and definitely not anything to do this this issue. If you think you've hit an issue with prefsniff, please file an issue with some additional context.

Locking this conversation