Documents #32
Documents #32
Conversation
mramputatoes
requested review from
ebnersam,
collinjensen,
santorap and
sntemple12
There was a problem hiding this comment.
Great job on figuring out a solution to those issues you were having with your M1 Mac, Jeremiah! I have a couple of suggestions for improvements in my comments below. I think it makes sense for them to be incorporated before merging into main, but it is up to you.
README.md
Outdated
| - run: `conda activate NAME`: activates the conda environment. | ||
| - The conda environment needs to running in order for the application to run. | ||
| - run: `conda install -c conda-forge -y psycopg2 numpy pandas`: install necessary dependencies. | ||
| - Create the .env file in the folder. |
There was a problem hiding this comment.
Instead of repeating the instructions from above, it makes more sense to reference them directly here. This way if there needs to be a change it only has to happen in once in one place, reducing the possibility for errors in the future.
| @@ -73,6 +73,25 @@ database. | |||
| - run:`pipenv shell` to start the pipenv environment. | |||
| - run:`uvicorn app.main:app --reload` to start running the fast api. | |||
|
|
|||
| ### Running the DS application with Apple M1 | |||
|
|
|||
There was a problem hiding this comment.
Maybe add a brief description of the problem you ran into that requires your to do these additional steps before starting with line 68? (I.e. Getting errors when trying to install psycopg2.)
| @@ -75,6 +75,7 @@ database. | |||
|
|
|||
| ### Running the DS application with Apple M1 | |||
|
|
|||
| - When you `pipenv install --dev` on the M1 you will most likely run into issues where the Pipfile will fail to lock due to issues with psycopg2. Psyocopg2 specifically has issues pip installing on the M1. After figuring out past issues with the M1, this is a work around until there is further bug fixing on compatibility. | |||
There was a problem hiding this comment.
Great explanation! Here is some more information about the issue for future reference: psycopg/psycopg2#1208 (comment)
https://stackoverflow.com/questions/66777470/psycopg2-installed-on-m1-running-macos-big-sur-but-unable-to-run-local-server
| @@ -73,6 +73,20 @@ database. | |||
| - run:`pipenv shell` to start the pipenv environment. | |||
| - run:`uvicorn app.main:app --reload` to start running the fast api. | |||
|
|
|||
| ### Running the DS application with Apple M1 | |||
|
|
|||
| - When you `pipenv install --dev` on the M1 you will most likely run into issues where the Pipfile will fail to lock due to issues with psycopg2. Psyocopg2 specifically has issues pip installing on the M1. After figuring out past issues with the M1, this is a work around until there is further bug fixing on compatibility. | |||
There was a problem hiding this comment.
Very helpful to explain the issue here.
| - run: `conda activate NAME`: activates the conda environment. | ||
| - The conda environment needs to running in order for the application to run. | ||
| - run: `conda install -c conda-forge -y psycopg2 numpy pandas`: install necessary dependencies. | ||
| - Create the .env file in the folder and continue following the instructions in the section above. |
There was a problem hiding this comment.
I usually don't like reading instructions then scrolling back up to continue but I can't imagine a better place for this so... no worries
Description
Updated README.md to include how the run the DS API locally when using a Mac OS with the Apple Silicone aram (M1 processor). https://www.youtube.com/watch?v=NJ6t97MmWiA
Fixes # (issue)
Type of change
Please delete options that are not relevant.
Change status
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Checklist:
Everything in this checklist is required for each PR. Please do not approve a PR that does not have all of these items.