You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ponymail.apache.org by se...@apache.org on 2021/09/20 16:02:00 UTC

[incubator-ponymail-foal] branch master updated: Move requirements.txt to tools

This is an automated email from the ASF dual-hosted git repository.

sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-ponymail-foal.git


The following commit(s) were added to refs/heads/master by this push:
     new 1559444  Move requirements.txt to tools
1559444 is described below

commit 15594448112b7e81bab8803e407650887bc87271
Author: Sebb <se...@apache.org>
AuthorDate: Mon Sep 20 17:00:30 2021 +0100

    Move requirements.txt to tools
---
 .github/workflows/unittest.yml             |  2 +-
 .travis.yml                                |  3 ++-
 INSTALL.md                                 | 21 ++++++++++++---------
 README.md                                  |  2 +-
 requirements.txt => tools/requirements.txt |  0
 5 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/.github/workflows/unittest.yml b/.github/workflows/unittest.yml
index 69499f9..4bfd0fc 100644
--- a/.github/workflows/unittest.yml
+++ b/.github/workflows/unittest.yml
@@ -25,7 +25,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
+        pip install -r tools/requirements.txt
         pip install html2text # optional dependency, but needed for tests
 #    - name: Test with pytest
 #      run: |
diff --git a/.travis.yml b/.travis.yml
index 341d6f2..8049352 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -23,8 +23,9 @@ before_script:
   - pip install mypy
 
 script:
+  # Is this needed? There are no server tests currently
   - pip install -r server/requirements.txt
-  - pip install -r requirements.txt
+  - pip install -r tools/requirements.txt
   - mypy --cache-dir /tmp/ --install-types
   - mypy --cache-dir /tmp/ --ignore-missing-imports tools/archiver.py
   - mypy --cache-dir /tmp/ --ignore-missing-imports tools/import-mbox.py
diff --git a/INSTALL.md b/INSTALL.md
index e6e3e8c..1588470 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -2,13 +2,17 @@
 
 <!-- toc -->
 
-- [Basic requirements](#basic-requirements)
-- [Installation steps:](#installation-steps)
-- [Archiving new emails via Postfix or the likes](#archiving-new-emails-via-postfix-or-the-likes)
-- [Setting up OAuth](#setting-up-oauth)
-  * [Setting up Google OAuth](#setting-up-google-oauth)
-  * [Setting up GitHub OAuth](#setting-up-github-oauth)
-- [Setting up web replies](#setting-up-web-replies)
+- [Installation instructions](#installation-instructions)
+  - [Basic requirements](#basic-requirements)
+  - [Installation steps:](#installation-steps)
+- [Load required modules](#load-required-modules)
+  - [Archiving new emails via Postfix or the likes](#archiving-new-emails-via-postfix-or-the-likes)
+  - [Setting up OAuth](#setting-up-oauth)
+    - [Setting up Google OAuth](#setting-up-google-oauth)
+    - [Setting up GitHub OAuth](#setting-up-github-oauth)
+  - [Setting up web replies](#setting-up-web-replies)
+  - [Hiding tracebacks from users](#hiding-tracebacks-from-users)
+  - [Archiving options](#archiving-options)
 
 <!-- tocstop -->
 
@@ -24,7 +28,7 @@
 - Clone the Foal git repository to your machine: `git clone https://github.com/apache/incubator-ponymail-foal.git foal`
 - Install the Python requirements for the setup:
 ~~~shell script
-cd foal/
+cd foal/tools
 pipenv install -r requirements.txt
 ~~~
 - Install any desired optional dependencies, for example:
@@ -33,7 +37,6 @@ pipenv install -r requirements.txt
   - zope (Zope Public Licence 2.1) - required for Mailman integration
 - Run the setup process:
 ~~~shell script
-cd tools/
 pipenv run python3 setup.py
 cd ..
 ~~~
diff --git a/README.md b/README.md
index 4248f39..724ce86 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,7 @@ Please see the [installation documentation](INSTALL.md) for setup instructions.
 - - FreeBSD
 - - Windows
 - - Mac OS
-- Python 3.7.3 or higher with dependencies from `requirements.txt`.
+- Python 3.7.3 or higher with dependencies from `requirements.txt` in tools/ and server/ as needed.
 - Web server with proxy capabilities for the UI.
 - ElasticSearch 7.x or higher.
 
diff --git a/requirements.txt b/tools/requirements.txt
similarity index 100%
rename from requirements.txt
rename to tools/requirements.txt