remove IDEone password from code, revamp Makefile and add ability to set default website from env var

Author: ronreiter

.gitignore

@@ -4,4 +4,5 @@
 learnpython_env/
 
 .vscode/
-venv
+venv
+app.env

Makefile

@@ -4,3 +4,8 @@ run-daemon:
 	docker-compose up -d
 run-js:
 	DEFAULT_DOMAIN=learn-js.org docker-compose up
+build-local:
+	python3 -m venv venv
+	venv/bin/pip install -r requirements.txt
+run-local:
+	venv/bin/python main.py

README.md

@@ -15,15 +15,20 @@ This is the open source repository for the free interactive tutorial websites:
 * [learn-perl.org](https://www.learn-perl.org)
 * [learnrubyonline.org](https://www.learnrubyonline.org)
 * [learn-golang.org](https://www.learn-golang.org)
-* [learnRust.org](https://learnRust.org)
+* [learnrust.org](https://learnrust.org)
 
 Please feel free to contribute your tutorials or exercises by sending a pull request and adding yourself on the list.
 
-To run locally in a Docker container, execute:
+To run locally, first create a new file called `app.env` based on `app.env.example`.
+(you don't need working credentials to run the website, just to execute code).
 
-    make run
+### Running with Docker
 
-This command will run learnpython.org website by default
+Execute:
+
+    DEFAULT_DOMAIN=learnpython.org make run
+
+This command will run learnpython.org website by default using Docker Compose.
 
 To run a specific website, run with the DEFAULT_DOMAIN option set, as follows:
 
@@ -33,18 +38,22 @@ By default, the server process will run at http://localhost:5000.
 
 The web server will locally compile and load all Markdown files into memory. The docker needs to be rebuilt upon any change in the Python code or the Markdown code.
 
-To run the development server outside of a Docker, create a Python 3 virtualenv and install the requirements. 
+### Running without Docker (locally)
 
-    # create the virtualenv
-    mkvirtualenv interactive-tutorials
-    
-    # install requirements
-    pip install -r requirements.txt
-    
-    # run the development server. Replace learnpython.org with the domain you are working on e.g. learn-golang.org
-    python main.py -d learnpython.org
+To run the development server outside of a Docker, run the following command once: 
+
+    make build-local
+
+And then run:
+
+    DEFAULT_DOMAIN=learn-js.org make run-local
 
 
+### IDEOne Credentials
+
+To make the IDEOne execution API work locally, you must obtain a username and password, 
+and add the credentials to a file called app.env.
+(TBD: add an option to use the remote version) 
 
 Contributors
 ============

app.env.example

@@ -0,0 +1,2 @@
+IDEONE_USERNAME=<user>
+IDEONE_PASSWORD=<password>

constants.py

@@ -1,5 +1,3 @@
-IDEONE_USERNAME = "ronreiter"
-IDEONE_PASSWORD = "18132ce2b97e"
 CACHE_HOST = "direct.learnpython.org"
 DB_HOST = "direct.learnpython.org"
 SECRET_KEY = "this is a secret. really."

docker-compose.yaml

@@ -7,4 +7,6 @@ services:
     volumes: ['./:/usr/src/app']
     environment:
     - DEFAULT_DOMAIN=learnpython.org
+    env_file:
+      - app.env
     entrypoint: ["python", "main.py", "-d", "$DEFAULT_DOMAIN", "-H", "0.0.0.0"]

main.py

@@ -28,7 +28,7 @@
 sections = re.compile(r"Tutorial\n[=\-]+\n+(.*)\n*Tutorial Code\n[=\-]+\n+(.*)\n*Expected Output\n[=\-]+\n+(.*)\n*Solution\n[=\-]+\n*(.*)\n*", re.MULTILINE | re.DOTALL)
 WIKI_WORD_PATTERN = re.compile('\[\[([^]|]+\|)?([^]]+)\]\]')
 
-current_domain = constants.LEARNPYTHON_DOMAIN  # python
+current_domain = os.environ.get("DEFAULT_DOMAIN", constants.LEARNPYTHON_DOMAIN)
 
 if __name__ == '__main__':
     import argparse
@@ -38,7 +38,6 @@
         "--domain",
         help="Default domain when running in development mode",        
         default=current_domain,
-        required=True,
         choices=list(constants.DOMAIN_DATA.keys())
     )
 
@@ -66,8 +65,8 @@
 
 def run_code(code, language_id):
     ideone_api = Ideone(
-        constants.IDEONE_USERNAME,
-        constants.IDEONE_PASSWORD,
+        os.environ['IDEONE_USERNAME'],
+        os.environ['IDEONE_PASSWORD'],
         api_url='http://ronreiter.compilers.sphere-engine.com/api/1/service.wsdl')
 
     code = ideone_api.create_submission(code, language_id=language_id, std_input="")["link"]