Skip to content

Commit

Permalink
Merge pull request #76 from ral-facilities/72_add_requirements_file
Browse files Browse the repository at this point in the history
Add requirements file
  • Loading branch information
keiranjprice101 authored Oct 2, 2019
2 parents beff0de + da0622f commit 87e7bbb
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions requirements.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
flask_restful == 0.3.7
sqlalchemy == 1.3.8
pymysql == 0.9.3
pyyaml == 5.1.2
19 changes: 19 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 87e7bbb

Please sign in to comment.