Merge pull request #2517 from chaoss/dev

Installation Docs Update

.gitignore

@@ -4,13 +4,12 @@ env.txt
 docker_env.txt
 pyenv.txt
 augur_export_env.sh
-.DS_Store
+*DS_Store
 *.config.json
 !docker.config.json
 config.yml
 reports.yml
 
-
 node_modules/
 .idea/
 logs/

README.md

@@ -1,4 +1,4 @@
-# Augur NEW Release v0.53.0
+# Augur NEW Release v0.53.1
 
 [![first-timers-only](https://img.shields.io/badge/first--timers--only-friendly-blue.svg?style=flat-square)](https://www.firsttimersonly.com/) We follow the [First Timers Only](https://www.firsttimersonly.com/) philosophy of tagging issues for first timers only, and walking one newcomer through the resolution process weekly. [You can find these issues tagged with "first timers only" on our issues list.](https://github.com/chaoss/augur/labels/first-timers-only).
 
@@ -8,7 +8,7 @@
 ### [If you want to jump right in, updated docker build/compose and bare metal installation instructions are available here](docs/new-install.md)
 
 
-Augur is now releasing a dramatically improved new version to the main branch. It is also available here: https://github.com/chaoss/augur/releases/tag/v0.53.0
+Augur is now releasing a dramatically improved new version to the main branch. It is also available here: https://github.com/chaoss/augur/releases/tag/v0.53.1
 - The `main` branch is a stable version of our new architecture, which features:
   - Dramatic improvement in the speed of large scale data collection (100,000+ repos). All data is obtained for 100k+ repos within 2 weeks.
   - A new job management architecture that uses Celery and Redis to manage queues, and enables users to run a Flower job monitoring dashboard

docker/backend/Dockerfile

@@ -2,7 +2,7 @@
 FROM python:3.8.11-slim-buster
 
 LABEL maintainer="outdoors@acm.org"
-LABEL version="0.53.0"
+LABEL version="0.53.1"
 
 ENV DEBIAN_FRONTEND=noninteractive
 

docker/database/Dockerfile

@@ -2,7 +2,7 @@
 FROM postgres:12
 
 LABEL maintainer="outdoors@acm.org"
-LABEL version="0.53.0"
+LABEL version="0.53.1"
 
 ENV POSTGRES_DB "test"
 ENV POSTGRES_USER "augur"

docs/dev-osx-install.md

@@ -1,5 +1,7 @@
 ## Augur Setup
 
+**NOTE**: Currently, our machine learning dependencies allow Augur to only fully support python 3.8 to python 3.10. Python 3.11 will sometimes work, but often there are libraries at the operating system level that have not yet been updated to support machine learning libraries at python 3.11. 
+
 # OSX: Note: This has **MOSTLY** been tested on Apple Silicon with Python 3.11 at this time, however, one user has been successful with Intel based Apple computers.
 ## For OSX You Need to make sure to install XCode Command line tools: 
 ```shell
@@ -38,6 +40,19 @@ export PKG_CONFIG_PATH="/opt/homebrew/opt/openblas/lib/pkgconfig"
 ## Pre-Requisite Operating System Level Packages
 Here we ensure your system is up to date, install required python libraries, install postgresql, and install our queuing infrastrucutre, which is composed of redis-server and rabbitmq-server
 
+### Updating your Path: Necessary for rabbitmq on OSX
+#### for macOS Intel
+`export PATH=$PATH:/usr/local/sbin`
+#### for Apple Silicon
+`export PATH=$PATH:/opt/homebrew/sbin`
+
+***These should be added to your .zshrc or other environment file loaded when you open a terminal***
+
+#### for macOS Intel
+`export PATH=$PATH:/usr/local/sbin:$PATH`
+#### for Apple Silicon
+`export PATH=$PATH:/opt/homebrew/sbin:$PATH`
+
 ### Executable
 ```shell 
 brew update ; 
@@ -77,19 +92,6 @@ rabbitmqctl set_user_tags augur augurTag administrator;
 rabbitmqctl set_permissions -p augur_vhost augur ".*" ".*" ".*";
 ```
 
-### Updating your Path: Necessary for rabbitmq on OSX
-#### for macOS Intel
-`export PATH=$PATH:/usr/local/sbin`
-#### for Apple Silicon
-`export PATH=$PATH:/opt/homebrew/sbin`
-
-***These should be added to your .zshrc or other environment file loaded when you open a terminal***
-
-#### for macOS Intel
-`export PATH=$PATH:/usr/local/sbin:$PATH`
-#### for Apple Silicon
-`export PATH=$PATH:/opt/homebrew/sbin:$PATH`
-
 - We need rabbitmq_management so we can purge our own queues with an API call 
 - We need a user
 - We need a vhost