jacow_validator

Scripts to validate JACoW docx proceedings against the official template.

Setup using AustralianSynchrotron jacow-validator

git clone git@github.com:AustralianSynchrotron/jacow-validator.git
pipenv install --dev
cd jacow-validator

At time of writing the references.csv file can be accessed at the following: https://spms.kek.jp/pls/ipac19/references.csv

grab a copy of it and save it to your computer

Create two environment variables:

URL_TO_JACOW_REFERENCES_CSV=https://spms.kek.jp/pls/ipac19/references.csv
PATH_TO_JACOW_REFERENCES_CSV=/home/user/Documents/jacow/References.csv

Where URL_TO_JACOW_REFERENCES_CSV is set to the currently applicable url and PATH_TO_JACOW_REFERENCES_CSV is set to the location on your filesystem where you saved the file.

Setup using forked jacow-validator

1. Fork this project to your own github account

2. Clone your fork to your computer

3. Add the AustralianSynchrotron repo as one of your remote's called "upstream":

   git remote add upstream https://github.com/AustralianSynchrotron/jacow-validator.git

4. Ensure pipenv is installed:

   1. For linux, ensure homebrew is installed - could require a restart

   2. brew install pipenv

   3. alternatively without homebrew: pip install pipenv

5. Ensure your pipenv is running the latest version of python:

   1. In a terminal cd into your project's directory

   2. pipenv install python 3.7 (this project makes use of syntax only available in python > 3.5)

6. Ensure dependencies are installed: pipenv install

Running

(for development mode create a .env file with FLASK_ENV=development)

pipenv run app

open http://localhost:5000/

Running in PyCharm

These steps work for pycharm's community edition which doesn't feature native flask support.

1. Open pycharm and open the project

2. File > Settings > this project > project interpreter

   a. Set the interpreter to use pipenv

3. Run > Edit Configurations > Add new configuration (+ button) > Choose Python

   1. Name it jacow-validator or similar

   2. Set the script path to point to the flask that is used by your pipenv virtual environment

      1. You can find the location of your virtual environment's files using the command pipenv --venv ran from within your project directory

      2. Your flask script will be located within a bin folder at that location so if pipenv --venv outputs:

         /home/user/.local/share/virtualenvs/jacow-validator-Awl2i6Az/

         then you will need to enter into the script path field:

         /home/user/.local/share/virtualenvs/jacow-validator-Awl2i6Az/bin/flask

   3. In the parameters type run

   4. Add a new environment variable called FLASK_APP and set it to the path to the wsgi.py file in the project root:

      example: FLASK_APP=/home/user/apps/jacow-validator/wsgi.py

4. Hitting the (play) or (debug) buttons in pycharm should now work to launch the app which you should now be able to see at http://localhost:5000/

Testing

pipenv run tox

Testing in pycharm

1. Locate the tox.ini file in your file explorer

2. Right click tox.ini and select run 'Tox'

3. Note that you may have to reselect your flask run configuration afterwards in the top right of the IDE.

Deployment

In the interests of keeping this readme clean and relevant to local development, the details of where and how this project was deployed can be found in the deployment readme