From 8b2251da598346008e4dc2f9aac9455d489254f6 Mon Sep 17 00:00:00 2001 From: Youen Toupin Date: Thu, 11 Aug 2022 22:31:05 +0200 Subject: [PATCH] added python requirements --- README.md | 21 +++++++++++++++++++-- requirements.txt | 9 +++++++++ 2 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 requirements.txt diff --git a/README.md b/README.md index 4675607..ba17760 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ -# sphinx-web +Python web app to publish documentation compiled using Sphinx -Python web app to publish documentation compiled using Sphinx \ No newline at end of file +# Installation + +``` shell +cd sphinx-web +python3 -m venv venv +source venv/bin/activate # on Windows execute instead: venv\Scripts\activate.bat +python3 -m pip install -r requirements.txt +``` + +# Development + +## Update dependencies + +After activating the virtual environment, run this command to update the list of dependencies with what is currently installed: + +``` shell +pip freeze > requirements.txt +``` diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..97e4624 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,9 @@ +click==8.1.3 +colorama==0.4.5 +Flask==2.2.2 +importlib-metadata==4.12.0 +itsdangerous==2.1.2 +Jinja2==3.1.2 +MarkupSafe==2.1.1 +Werkzeug==2.2.2 +zipp==3.8.1