Skip to content

Commit

Permalink
Merge branch 'main' into upstream/retry-callbacks-on-429
Browse files Browse the repository at this point in the history
  • Loading branch information
jimleroyer authored Apr 18, 2024
2 parents 8bd7f34 + f664568 commit ad8b039
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 76 deletions.
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,19 @@ smoke-test:

.PHONY: run
run: ## Run the web app
flask run -p 6011 --host=0.0.0.0
poetry run flask run -p 6011 --host=0.0.0.0

.PHONY: run-celery-local
run-celery-local: ## Run the celery workers with all the queues
./scripts/run_celery_local.sh
poetry run ./scripts/run_celery_local.sh

.PHONY: run-celery-local-filtered
run-celery-local-filtered: ## Run the celery workers with all queues but filter out common scheduled tasks
./scripts/run_celery_local.sh 2>&1 >/dev/null | grep -iEv 'beat|in-flight-to-inbox|run-scheduled-jobs|check-job-status'
poetry run ./scripts/run_celery_local.sh 2>&1 >/dev/null | grep -iEv 'beat|in-flight-to-inbox|run-scheduled-jobs|check-job-status'

.PHONY: run-celery-purge
run-celery-purge: ## Purge the celery queues
./scripts/run_celery_purge.sh
poetry run ./scripts/run_celery_purge.sh

.PHONY: run-db
run-db: ## psql to access dev database
Expand Down
73 changes: 1 addition & 72 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,78 +17,7 @@ Contains:
For any issues during the following instructions, make sure to review the
**Frequent problems** section toward the end of the document.

### Local installation instruction

#### On OS X:

1. Install PyEnv with Homebrew. This will preserve your sanity.

`brew install pyenv`

2. Install Python 3.10.8 or whatever is the latest

`pyenv install 3.10.8`

3. If you expect no conflicts, set `3.10.8` as you default

`pyenv global 3.10.8`

4. Ensure it installed by running

`python --version`

if it did not, take a look here: https://github.com/pyenv/pyenv/issues/660

5. Install `poetry`:

`pip install poetry==1.3.2`

6. Restart your terminal and make your virtual environtment:

`poetry env use $(which python)`

8. Verify that the environment was created and activated by poetry

`poetry env list`

9. Install [Postgres.app](http://postgresapp.com/).

10. Create the database for the application

`createdb --user=postgres notification_api`

11. Install the required environment variables via our LastPast Vault

Within the team's *LastPass Vault*, you should find corresponding folders for this
project containing the `.env` content that you should copy in your project root folder. This
will grant the application necessary access to our internal infrastructure.

If you don't have access to our *LastPass Vault* (as you evaluate our notification
platform for example), you will find a sane set of defaults exists in the `.env.example`
file. Copy that file to `.env` and customize it to your needs.

12. Install all dependencies

`poetry install`

1. Generate the version file ?!?

`make generate-version-file`

14. Run all DB migrations

`flask db upgrade`

15. Run the service

`make run`

15a. To test

`poetry install --with test`

`make test`

### Local installation instruction (Use Dev Containers)
#### In a [VS Code devcontainer](https://code.visualstudio.com/docs/remote/containers-tutorial)

1. Install VS Code
Expand Down

0 comments on commit ad8b039

Please sign in to comment.