Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Installation Docs Update #2517

Merged
merged 3 commits into from
Sep 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docker/backend/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
FROM python:3.8.11-slim-buster

LABEL maintainer="[email protected]"
LABEL version="0.53.0"
LABEL version="0.53.1"

ENV DEBIAN_FRONTEND=noninteractive

Expand Down
2 changes: 1 addition & 1 deletion docker/database/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
FROM postgres:12

LABEL maintainer="[email protected]"
LABEL version="0.53.0"
LABEL version="0.53.1"

ENV POSTGRES_DB "test"
ENV POSTGRES_USER "augur"
Expand Down
Binary file removed docs/.DS_Store
Binary file not shown.
28 changes: 15 additions & 13 deletions docs/dev-osx-install.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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 ;
Expand Down Expand Up @@ -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
Expand Down
Binary file removed docs/source/.DS_Store
Binary file not shown.
Binary file removed docs/source/development-guide/.DS_Store
Binary file not shown.
Binary file removed docs/source/getting-started/.DS_Store
Binary file not shown.
Loading
Loading