Improve installation instructions - fix errors #19
Comments
|
Thanks for catching this! I think these are requirements related to the Spirit forums, which requires postgres and pillow. (This site should use postgres on Heroku and sqlite3 locally.) We should link to their setup instructions regardless so people don't get confused about why the forum's not working if they don't follow the extra steps, but maybe doing the Spirit setup process will avoid some of the trouble you ran into? Or maybe not - I developed on Ubuntu and it may be that the process is just harder on Mac. I see that @aeltanawy already has a PR up to fix this. Up to you all if/how you want to incorporate this info. |
|
I had a similar issue with pip installing The error ends with: Full error text: https://gist.github.com/Ben-Hampson/70371c7390e67c6484b91a90778fb266 In previous Django projects to get around this I've pip installed I found this solution at https://stackoverflow.com/questions/26288042/error-installing-psycopg2-library-not-found-for-lssl |
|
@shaunagm, for some reason I didn't run into this issue on my Mac however I have developed with postgres before so my computer should have the required setup to run this app locally. The only thing I needed to do though is to build the database with |
|
Thank you, this is super helpful. I'm updating the issue to specify instructions for multiple platforms. @aeltanawy and @ben-hampson |
meg-ray
changed the title
meg-ray
changed the title
meg-ray
changed the title
Now that the requirements files are split up in psf#37 and the local dev environment has been simplified, we can now add a detailed and welcoming contribution guide. This absorbs the install instructions from the README and expounds on the install and local development process so as to enable new developers to contribute to the project easly. There were no guidelines in the README as far as commit hygene or other contribution guidelines, but it wouldn't be difficult to add later. fixes: psf#19, psf#26, psf#27 relies on: psf#37
When attempting to clone and install the project as instructed in the README, on a MacOS system, I first ran into an error related to installing
psycopg2:Collecting psycopg2==2.8.6 (from -r requirements.txt (line 16)) Using cached https://files.pythonhosted.org/packages/fd/ae/98cb7a0cbb1d748ee547b058b14604bd0e9bf285a8e0cc5d148f8a8a952e/psycopg2-2.8.6.tar.gz ERROR: Command errored out with exit status 1: command: /Users/martin/Documents/projects/python-in-edu/.venv/bin/python -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/private/var/folders/52/0zsd69115l57tf4st_1fw69w0000gn/T/pip-install-inoib_0k/psycopg2/setup.py'"'"'; __file__='"'"'/private/var/folders/52/0zsd69115l57tf4st_1fw69w0000gn/T/pip-install-inoib_0k/psycopg2/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' egg_info --egg-base pip-egg-info cwd: /private/var/folders/52/0zsd69115l57tf4st_1fw69w0000gn/T/pip-install-inoib_0k/psycopg2/ Complete output (23 lines): running egg_info creating pip-egg-info/psycopg2.egg-info writing pip-egg-info/psycopg2.egg-info/PKG-INFO writing dependency_links to pip-egg-info/psycopg2.egg-info/dependency_links.txt writing top-level names to pip-egg-info/psycopg2.egg-info/top_level.txt writing manifest file 'pip-egg-info/psycopg2.egg-info/SOURCES.txt' Error: pg_config executable not found. pg_config is required to build psycopg2 from source. Please add the directory containing pg_config to the $PATH or specify the full executable path with the option: python setup.py build_ext --pg-config /path/to/pg_config build ... or with the pg_config option in 'setup.cfg'. If you prefer to avoid building psycopg2 from source, please install the PyPI 'psycopg2-binary' package instead. For further information please check the 'doc/src/install.rst' file (also at <https://www.psycopg.org/docs/install.html>). ---------------------------------------- ERROR: Command errored out with exit status 1: python setup.py egg_info Check the logs for full command output.This is fixed by installing Postgres.
I suggest to add a note to the README that contributors need to have Postgres installed to be able to run the project locally.
Further, after successfully installing Postgres and adding it to my PATH, I ran into another error related to a missing installation of
libjpeg:I needed to install homebrew in order to install
jpegto finally get to a point wherepython -m pip install -r requirements.txtsucceeded without an error.tl;dr: On a new MacOS machine, there's quite some additional setup necessary just to get the project to run. I'm not exactly sure why (I've worked on Django projects on this computer before), but it would be helpful to add some pointers to the README file to make it more accessible for newcomers.
The text was updated successfully, but these errors were encountered: