darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-08-23 15:57:23 -04:00
Code Issues Packages Projects Releases Wiki Activity

README updates

Browse Source
This commit is contained in:
samathad2023
2024-03-19 09:19:26 -07:00
parent 94e05705f8
commit da5da1abe9
1 changed files with 30 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -185,12 +185,12 @@ session to make the changes take effect.
Now we're ready to install the Python version we need with `pyenv`, like so: Now we're ready to install the Python version we need with `pyenv`, like so:
```sh ```sh
pyenv install 3.9 pyenv install 3.12
``` ```
This will install the latest version of Python 3.9. This will install the latest version of Python 3.12.
_NOTE: This project currently runs on Python 3.9.x._ _NOTE: This project currently runs on Python 3.12.x._
#### [API Step] Python Dependency Installation #### [API Step] Python Dependency Installation
@@ -242,16 +242,16 @@ git clone git@github.com:GSA/notifications-admin.git
Now go into the project directory (`notifications-admin` by default), create a Now go into the project directory (`notifications-admin` by default), create a
virtual environment, and set the local Python version to point to the virtual virtual environment, and set the local Python version to point to the virtual
environment (assumes version Python `3.9.18` is what is installed on your environment (assumes version Python `3.12.2` is what is installed on your
machine): machine):
```sh ```sh
cd notifications-admin cd notifications-admin
pyenv virtualenv 3.9.18 notify-admin pyenv virtualenv 3.12.2 notify-admin
pyenv local notify-admin pyenv local notify-admin
``` ```
_If you're not sure which version of Python was installed with `pyenv`, you can check by running `pyenv versions` and it'll list everything available currently._ _If you're not sure which version of Python was installed with `pyenv`, you can check by running `pyenv versions` and it'll list everything available currently.You should see the virtual environment name in terminal as 'notify-admin'._
Now [log into cloud.gov](https://cloud.gov/docs/getting-started/setup/#set-up-the-command-line) Now [log into cloud.gov](https://cloud.gov/docs/getting-started/setup/#set-up-the-command-line)
in the command line by using this command: in the command line by using this command:
@@ -274,6 +274,30 @@ In addition to some infrastructure setup, this will also create a local `.env`
file for you in the project's root directory, which will include a handful of file for you in the project's root directory, which will include a handful of
project-specific environment variables. project-specific environment variables.
### Switching to different environment
Once all of pre-requisites for the project are installed and to switch to newer environment with newer python version follow the below steps to create new virtual environment.
First install the newer Python version we need with `pyenv`, (say the planned upgrade to 3.15) like so :
```sh
pyenv install 3.15
```
Now go into the project directory (`notifications-api` by default), create a
virtual environment, and set the local Python version to point to the virtual
environment (assumes version Python `3.15.2` is what is installed on your
machine):
```sh
cd notifications-api
pyenv virtualenv 3.15.2 notify-admin-upgrade
pyenv local notify-admin-upgrade
```
_If you're not sure which version of Python was installed with `pyenv`, you can check by running `pyenv versions` and it'll list everything available currently.you can deactivate the current environment by running `source deactivate` or `deactivate`.Close the terminal and reopen a new terminal should see the newer virtual environment name in terminal as 'notify-admin-upgrade'. you can the get python version ,executable, and other details for this environment by running `poetry env info`._
#### Updating the .env file for E2E tests #### Updating the .env file for E2E tests
With the newly created `.env` file in place, you'll need to make one more With the newly created `.env` file in place, you'll need to make one more