Add/test docs (#44)

* adding test documentation and fixing spack url bug

Signed-off-by: vsoch <vsoch@users.noreply.github.com>

CHANGELOG.md

@@ -14,6 +14,7 @@ and **Merged pull requests**. Critical items to know are:
 The versions coincide with releases on pip. Only major versions will be released as tags on GitHub.
 
 ## [0.0.x](https://github.com/vsoch/citelang/tree/main) (0.0.x)
+ - spack changed their packages url (0.0.32)
  - removing deprecated pypi argument and adding from_file to package base (0.0.31)
  - contrib does not count commits from other REFs, now uses git log without `--all` (0.0.30)
  - Default contrib does a deep search, with option to add `--shallow` (0.0.29)

citelang/main/packages/spack.py

@@ -17,7 +17,7 @@ class SpackManager(PackageManager):
     """
 
     name = "spack"
-    apiroot = "https://spack.github.io/packages/data"
+    apiroot = "https://packages.spack.io/data"
     homepage = "https://spack.github.io/packages"
     color = "#0f3a80"
     default_language = None

citelang/tests/test_packages.py

@@ -34,7 +34,6 @@
                 "spack",
                 "eigen3",
                 "openmp",
-                "lapack",
                 "python",
                 "curl",
                 "xpat",

citelang/version.py

@@ -2,7 +2,7 @@
 __copyright__ = "Copyright 2022, Vanessa Sochat"
 __license__ = "MPL 2.0"
 
-__version__ = "0.0.31"
+__version__ = "0.0.32"
 AUTHOR = "Vanessa Sochat"
 EMAIL = "vsoch@users.noreply.github.com"
 NAME = "citelang"

docs/getting_started/installation.rst

@@ -4,6 +4,9 @@
 Installation
 ============
 
+Install CiteLang
+----------------
+
 Install citelang from pypi:
 
 .. code-block:: console
@@ -19,4 +22,29 @@ or development from the code:
     $ cd citelang
     $ pip install -e .
 
+Testing
+-------
+
+To see full details about how citelang is tested, see ``.github/workflows``. To quickly test the
+library locally, you'll need to do a full install (badge generation libraries included) and bs4 for testing GitHub dependencies:
+
+.. code-block:: console
+
+   $ pip install -e .[all]
+   $ pip install bs4
+
+It's recommended (but not required) for tests that you have a `libraries.io <https://libraries.io>`_ API key exported. If you don't, the client will sleep while the API limit is exceeded (the test will appear to pause).
+
+.. code-block:: console
+
+     export CITELANG_LIBRARIES_KEY=xxxxxxxxxxxxxxx
+
+And then after that, and when you have citelang on your path:
+
+.. code-block:: console
+
+    $ cd citelang/tests
+    $ /bin/bash test_client.sh
+    $ pytest test_*.py
+
 Next check out the :ref:`getting_started-user-guide` pages for more detail to use the library.