carpentries · mhagdorn · Jun 7, 2023 · Jun 7, 2023 · Jun 7, 2023 · Jun 7, 2023
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+*~
+__pycache__
+build/
+learner_certificates.egg-info/
diff --git a/README.md b/README.md
@@ -1,13 +1,22 @@
 # Certificates for The Carpentries
 
+## Using the python program
 
-There are two ways to build certificates from this repo, one depends on the python package cairosvg which in turn depends on cairo development libraries being installed. To use this method, use `bin/certificates.py` to build certificates.
+The python program makes use of the `cairosvg` package and supports reading a csv file containing participants using the `pandas` package. You can either install the python package or run it directly from this repo.
+
+```
+python3 -m learner_certificates.certificates -h
+```
+
+## Using jinja2 directly
 
 The second, pure python method uses the python packages jinja2, jinja2-cli and svglib to build the certificates.
 
 To build certificates this way, you can run:
 ```
-jinja2 swc-attendance.svg -D name="Firstname Lastname" -D date="Nov. 6, 2017" -D instructor="Some Instructor Name" > lastname_firstname.svg
+jinja2 learner_certificates/templates/swc-attendance.svg \
+   -D name="Firstname Lastname" -D date="Nov. 6, 2017" \
+   -D instructor="Some Instructor Name" > lastname_firstname.svg
 svg2pdf lastname_firstname.svg 
 ```
 
diff --git a/bin/certificates.py b/bin/certificates.py
diff --git a/bin/makecert.sh b/bin/makecert.sh
diff --git a/learner_certificates/__init__.py b/learner_certificates/__init__.py
@@ -0,0 +1 @@
+from .__version__ import __version__  # noqa F401
diff --git a/learner_certificates/__version__.py b/learner_certificates/__version__.py
@@ -0,0 +1 @@
+__version__ = "0.0.1"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		from .__version__ import __version__ # noqa F401