Merge pull request #14 from coreofscience/feat/rich-display-integration-with-jupyter

Start the display thing

Author: jdalzatec

.github/workflows/pythonpackage.yml

@@ -19,23 +19,34 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
+
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements_dev.txt
+
     - name: Lint with flake8
       run: |
         pip install flake8
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
     - name: Test with pytest
       run: |
         pip install -e .
         pip install pytest
         pytest
+
+    - name: Test with sample data
+      run: |
+        sap describe data/sample.isi
+        sap root data/sample.isi
+        sap trunk data/sample.isi
+        sap leaf data/sample.isi

.github/workflows/pythonpublish.yml

@@ -19,10 +19,26 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: '3.x'
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install setuptools wheel twine
+        pip install -r requirements_dev.txt
+
+    - name: Test with pytest
+      run: |
+        pip install -e .
+        pip install pytest
+        pytest
+
+    - name: Test with sample data
+      run: |
+        sap describe data/sample.isi
+        sap root data/sample.isi
+        sap trunk data/sample.isi
+        sap leaf data/sample.isi
+
     - name: Build and publish
       env:
         TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}

CONTRIBUTING.md

@@ -1,13 +1,11 @@
-Contributing
-============
+# Contributing
 
 Contributions are welcome, and they are greatly appreciated! Every
 little bit helps, and credit will always be given.
 
 You can contribute in many ways:
 
-Types of Contributions
-----------------------
+## Types of Contributions
 
 ### Report Bugs
 
@@ -50,8 +48,7 @@ If you are proposing a feature:
 -   Remember that this is a volunteer-driven project, and that
     contributions are welcome :)
 
-Get Started!
-------------
+## Get Started!
 
 Ready to contribute? Here\'s how to set up [python\_tos]{.title-ref} for
 local development.
@@ -103,8 +100,7 @@ local development.
 
 7.  Submit a pull request through the GitHub website.
 
-Pull Request Guidelines
------------------------
+# Pull Request Guidelines
 
 Before you submit a pull request, check that it meets these guidelines:
 

HISTORY.md

@@ -1,7 +1,15 @@
-History
-=======
+# History
 
-0.1.0 (2020-01-26)
-------------------
+## 1.0.0 (2020-08-15)
 
--   First release on PyPI.
+- Added a new Jupyter visualization.
+- Updated the python wostools dependency to the new version.
+- Got the API at production level.
+
+## 0.1.1 (2020-05-20)
+
+- New stable API.
+
+## 0.1.0 (2020-01-26)
+
+- First release on PyPI.

MANIFEST.in

@@ -7,4 +7,4 @@ recursive-include tests *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]
 
-recursive-include docs *.md conf.py Makefile make.bat *.jpg *.png *.gif
+recursive-include docs *.md conf.py Makefile make.bat *.jpg *.png *.gif *.html

README.md

@@ -56,11 +56,11 @@ to explore all the commands and options you can use.
 The Python API is quite small, here's the minimal working example:
 
 ```python
-from sap import load, Sap, CollectionLazy
+from sap import load, Sap, CachedCollection
 
 sap = Sap()
-graph = next(load(CollectionLazy(file1, file2, ...)))
-tree = sap.tree()
+graph = giant(CachedCollection(file1, file2, ...))
+tree = sap.tree(giant)
 ```
 
 then `tree` is an `igraph.Graph` labeled with all the things you would need