diff --git a/README.md b/README.md index 0a3ba221..1d907c7e 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,15 @@ ICAT API to interface with the Data Gateway ## Requirements +All requirements can be installed with `pip install -r requirements.txt` + The required python libraries: - [SQLAlchemy](https://www.sqlalchemy.org/) - [flask-restful](https://github.com/flask-restful/flask-restful/) - [pymysql](https://pymysql.readthedocs.io/en/latest/) - [requests](https://2.python-requests.org/en/master/) - [pyyaml](https://pyyaml.org/wiki/PyYAMLDocumentation) (For the swagger generation) + - [pip-tools](https://github.com/jazzband/pip-tools) (For generating requirements.txt) ## Setup and running the API The database connection needs to be set up first. This is set in config.json, an example config file called `config.json.example` is provided. diff --git a/requirements.in b/requirements.in new file mode 100644 index 00000000..77a79dbe --- /dev/null +++ b/requirements.in @@ -0,0 +1,4 @@ +flask_restful == 0.3.7 +sqlalchemy == 1.3.8 +pymysql == 0.9.3 +pyyaml == 5.1.2 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..4b29aa69 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,19 @@ +# +# This file is autogenerated by pip-compile +# To update, run: +# +# pip-compile +# +aniso8601==8.0.0 # via flask-restful +click==7.0 # via flask +flask==1.1.1 # via flask-restful +flask_restful==0.3.7 +itsdangerous==1.1.0 # via flask +jinja2==2.10.1 # via flask +markupsafe==1.1.1 # via jinja2 +pymysql==0.9.3 +pytz==2019.2 # via flask-restful +pyyaml==5.1.2 +six==1.12.0 # via flask-restful +sqlalchemy==1.3.8 +werkzeug==0.16.0 # via flask