From 56a1ced5115083cb13ee99fbc651601383f6f13a Mon Sep 17 00:00:00 2001 From: Richard Gregory Date: Sep 08 2020 12:42:15 +0000 Subject: docs: Update README.md Signed-off-by: Richard Gregory --- diff --git a/README.md b/README.md index df3ed2a..04272b8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,40 @@ # geofp -Is a Python Class than query the Fedora Account System and get Geographical data from groups ans fedora ASK +GEOFP is a Python Class that queries the Fedora Account System and gets geographical data from groups in Fedora ASK. -ToDO: +## Requirements + +Python 3 + +pip3 - comes with Python 3 + +Virtual Environment (`pip3 install virtualenv`) + +## Set-up + +To set-up a new virtual environment, run `virtualenv geofp` + +#### Mac OS / Linux +Enter `source geofp/bin/activate` to activate virtual environment. + +#### Windows +`geofp\Scripts\activate` + +Enter the cmd `deactivate` whenever you want to exit virtual environment. + +While in projects root directory, run `pip3 install -r requirements.txt`. If you get an error regarding fedora, run `pip3 install python-fedora`. + +It's recommended that you run the program with jupyter-notebook to be able to view the maps: `pip3 install jupyter` + +Create a file name myconfig.cfg. Copy the content of myconfig.cfg.example and paste in myconfig.cfg. Enter your FAS credentials in the file. + +In your terminal, run enter `jupyter notebook`. A new window should open in your browser at `http://localhost:8888` + +For a sample, open a new terminal in the jupyter web app. Run `python fedora_join_example.py`. You should see an image like the one below open in another window: +![sample-plot](fedora-commops/geofp/raw/master/f/doc/img/sample-plot.png) + +### ToDos: -* A better documentation * A (nice) jupyter-notebook with examples of use * Heatmap * virtualenv diff --git a/doc/img/sample-plot.png b/doc/img/sample-plot.png new file mode 100644 index 0000000..c90417b Binary files /dev/null and b/doc/img/sample-plot.png differ