Merge pull request #6 from dag-hammarskjold-library/20240821

activate.sh; cleanup

.gitignore

@@ -123,7 +123,7 @@ celerybeat.pid
 .env
 .venv
 env/
-venv/
+venv*
 ENV/
 env.bak/
 venv.bak/

activate.sh

@@ -0,0 +1,3 @@
+# Shortcut for activating any venv found in the current dir. Run using `source activate.sh`
+
+source $(find . | grep -E "^./v?env.*/bin/activate$")

package/module.py

@@ -1,3 +1,4 @@
+# module
 
 class Class():
     def __init__(self):

package/scripts/script.py

@@ -1,3 +1,5 @@
+# This is meant to be run from the command line. It can be configured to be
+# installed as a CLI command using the 'entry_points' parameter in setup.py 
 
 import sys
 from argparse import ArgumentParser
@@ -14,4 +16,9 @@ def run():
     c = Class()
     c.hello_world()
 
-    return
+    return
+
+###
+
+if __name__ == '__main__':
+    run()

package/tests/conftest.py

@@ -1,5 +1,5 @@
 # set up pytest fixtures 
-# here https://docs.pytest.org/en/7.1.x/reference/fixtures.html#conftest-py-sharing-fixtures-across-multiple-files
+# https://docs.pytest.org/en/8.2.x/explanation/fixtures.html#about-fixtures
 
 import pytest
 

package/tests/test_module.py

@@ -1,3 +1,4 @@
+import pytest
 
 def test_module():
     return

package/tests/test_scripts.py

@@ -1,4 +1,4 @@
-import sys
+import sys, pytest
 from package.scripts import script
 
 def test_script():