Merge pull request #2 from alexandreMayerowitz/main

Deployment on PYPI

.github/workflows/python-publish.yml

@@ -0,0 +1,31 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.readthedocs.yml

@@ -8,6 +8,7 @@ version: 2
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/source/conf.py
+  fail_on_warning: false
 
 conda:
   environment: environment.yml

MANIFEST.in

@@ -1,2 +1,2 @@
-include playground_plums/dataflow/utils/parser/grammar.lark
-include playground_plums/plot/engine/fonts/*.ttf
+include plums/dataflow/utils/parser/grammar.lark
+include plums/plot/engine/fonts/*.ttf

README.md

@@ -14,7 +14,7 @@ debug and reuse.
 Installation is simple with *PyPI* repository:
 
 ```bash
-pip install playground-plums
+pip install plums
 ```
 
 [TODO]
@@ -32,7 +32,7 @@ reusable classes and utilities for all other packages.
 To import do:
 
 ```python
-import playground_plums.commons
+import plums.commons
 ```
 
 ### Plot
@@ -44,7 +44,7 @@ results.
 To import do:
 
 ```python
-import playground_plums.plot
+import plums.plot
 ```
 
 ### Model
@@ -57,7 +57,7 @@ producer and consumer codebases.
 To import do:
 
 ```python
-import playground_plums.model
+import plums.model
 ```
 
 ### Dataflow
@@ -68,7 +68,7 @@ handling.
 To import do:
 
 ```python
-import playground_plums.dataflow
+import plums.dataflow
 ```
 
 -------------------------------------------------------------------

docs/source/api_doc/plums.commons.data.rst

@@ -20,40 +20,40 @@ It consists of 2 categories of classes:
 Container classes
 -----------------
 
-.. autoclass:: playground_plums.commons.data.data.DataPoint
+.. autoclass:: plums.commons.data.data.DataPoint
     :members:
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
-.. autoclass:: playground_plums.commons.data.data.Annotation
+.. autoclass:: plums.commons.data.data.Annotation
     :members:
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
 .. Test
-.. automodule:: playground_plums.commons
+.. automodule:: plums.commons
     :members: DataPoint, Annotation
     :undoc-members:
     :show-inheritance:
     :exclude-members: p, r, o, e, t, i, s
     :member-order: bysource
 
-.. autoclass:: playground_plums.commons.data.tile.TileCollection
+.. autoclass:: plums.commons.data.tile.TileCollection
     :members:
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
-.. autoclass:: playground_plums.commons.data.record.RecordCollection(*records, id=None, taxonomy=None)
+.. autoclass:: plums.commons.data.record.RecordCollection(*records, id=None, taxonomy=None)
     :members:
     :special-members: __getitem__, __setitem__, __len__
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
-.. autoclass:: playground_plums.commons.data.mask.MaskCollection
+.. autoclass:: plums.commons.data.mask.MaskCollection
     :members:
     :special-members: __getitem__
     :undoc-members:
@@ -66,20 +66,20 @@ Type classes
 Tile classes
 ++++++++++++
 
-.. autoclass:: playground_plums.commons.data.tile.Tile
+.. autoclass:: plums.commons.data.tile.Tile
     :members:
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
-.. autoclass:: playground_plums.commons.data.tile.TileWrapper
+.. autoclass:: plums.commons.data.tile.TileWrapper
     :members:
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
 .. Test
-.. automodule:: playground_plums.commons
+.. automodule:: plums.commons
     :members: Tile, TileWrapper
     :undoc-members:
     :show-inheritance:
@@ -89,7 +89,7 @@ Tile classes
 Record classes
 ++++++++++++++
 
-.. autoclass:: playground_plums.commons.data.record.Record
+.. autoclass:: plums.commons.data.record.Record
     :members:
     :undoc-members:
     :show-inheritance:
@@ -98,20 +98,20 @@ Record classes
 Mask classes
 ++++++++++++
 
-.. autoclass:: playground_plums.commons.data.mask.VectorMask
+.. autoclass:: plums.commons.data.mask.VectorMask
     :members:
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
-.. autoclass:: playground_plums.commons.data.mask.RasterMask
+.. autoclass:: plums.commons.data.mask.RasterMask
     :members:
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
 .. Test
-.. automodule:: playground_plums.commons
+.. automodule:: plums.commons
     :members: VectorMask, RasterMask
     :undoc-members:
     :show-inheritance:
@@ -124,32 +124,32 @@ Developper documentation
 Some internal classes used for interface-checking and semantic typing and base classes for the data model
 implementation.
 
-.. autoclass:: playground_plums.commons.data.mixin.PropertyContainer
+.. autoclass:: plums.commons.data.mixin.PropertyContainer
     :members:
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
-.. autoclass:: playground_plums.commons.data.base.ArrayInterfaced
+.. autoclass:: plums.commons.data.base.ArrayInterfaced
     :members:
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
-.. autoclass:: playground_plums.commons.data.base.GeoInterfaced
+.. autoclass:: plums.commons.data.base.GeoInterfaced
     :members:
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
 .. Test
-.. automodule:: playground_plums.commons.data
+.. automodule:: plums.commons.data
     :members: ArrayInterfaced, GeoInterfaced
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
-.. autoclass:: playground_plums.commons.data.Mask(name, id=None, **properties)
+.. autoclass:: plums.commons.data.Mask(name, id=None, **properties)
     :members:
     :undoc-members:
     :show-inheritance:
@@ -159,21 +159,21 @@ Implementation helpers
 ----------------------
 
 .. Test
-.. autoclass:: playground_plums.commons.data.mixin.PropertyContainer
+.. autoclass:: plums.commons.data.mixin.PropertyContainer
     :members:
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
 .. Test
-.. automodule:: playground_plums.commons.data.mixin
+.. automodule:: plums.commons.data.mixin
     :members:
     :exclude-members: PropertyContainer, p, r, o, e, t, i, s, d, c
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
-.. autoclass:: playground_plums.commons.data.base._Array
+.. autoclass:: plums.commons.data.base._Array
     :members:
     :undoc-members:
     :show-inheritance:

docs/source/api_doc/plums.commons.data.taxonomy.rst

@@ -17,15 +17,15 @@ It mainly consists in 3 classes:
 
 The Taxonomy API
 ----------------
-.. automodule:: playground_plums.commons
+.. automodule:: plums.commons
     :members: Taxonomy
     :undoc-members:
     :exclude-members: a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z
     :special-members: __eq__, __ne__, __contains__, __len__, __getitem__, __setitem__, __str__
     :show-inheritance:
     :member-order: bysource
 
-.. automodule:: playground_plums.commons
+.. automodule:: plums.commons
     :members: Label
     :undoc-members:
     :exclude-members: a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z
@@ -36,7 +36,7 @@ The Taxonomy API
 Trees helper classes
 --------------------
 
-.. automodule:: playground_plums.commons
+.. automodule:: plums.commons
     :members: Tree
     :undoc-members:
     :exclude-members: a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z
@@ -47,7 +47,7 @@ Trees helper classes
 Taxonomies iterators
 ....................
 
-.. automodule:: playground_plums.commons.data.taxonomy.iterator
+.. automodule:: plums.commons.data.taxonomy.iterator
     :members:
     :undoc-members:
     :exclude-members: a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z
@@ -58,7 +58,7 @@ Taxonomies iterators
 Taxonomies accessors
 ....................
 
-.. automodule:: playground_plums.commons.data.taxonomy.accessor
+.. automodule:: plums.commons.data.taxonomy.accessor
     :members:
     :undoc-members:
     :exclude-members: a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z

docs/source/api_doc/plums.commons.path.rst

@@ -6,7 +6,7 @@
 The |Path| class implements a subset of :mod:`pathlib` functionality and few additional
 ones. It is designed to integrate seamlessly with :mod:`pathlib` with efficient conversions.
 
-.. automodule:: playground_plums.commons
+.. automodule:: plums.commons
     :members: Path
     :special-members: __add__, __radd__, __contains__, __eq__
     :undoc-members:

docs/source/api_doc/plums.dataflow.dataset.rst

@@ -12,14 +12,14 @@ Base datasets
 The main class to stream through data in Plums is the |Dataset| base class, which guarantee a sequence-like
 interface to manipulate data in an ordered fashion.
 
-.. autoclass:: playground_plums.dataflow.dataset.Dataset
+.. autoclass:: plums.dataflow.dataset.Dataset
     :members:
     :special-members: __getitem__
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
-.. autoclass:: playground_plums.dataflow.dataset.SizedDataset
+.. autoclass:: plums.dataflow.dataset.SizedDataset
     :members:
     :special-members: __getitem__, __add__, __len__
     :undoc-members:
@@ -28,14 +28,14 @@ interface to manipulate data in an ordered fashion.
 
 Two utility |Dataset| classes are also provided to ease the creation of dataset partitions and compositions:
 
-.. autoclass:: playground_plums.dataflow.dataset.Subset
+.. autoclass:: plums.dataflow.dataset.Subset
     :members:
     :special-members: __getitem__, __len__
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
-.. autoclass:: playground_plums.dataflow.dataset.ConcatDataset
+.. autoclass:: plums.dataflow.dataset.ConcatDataset
     :members:
     :special-members: __getitem__, __len__
     :undoc-members:
@@ -45,7 +45,7 @@ Two utility |Dataset| classes are also provided to ease the creation of dataset
 Pattern dataset
 ---------------
 
-.. autoclass:: playground_plums.dataflow.dataset.PatternDataset
+.. autoclass:: plums.dataflow.dataset.PatternDataset
     :members:
     :special-members: __getitem__, __len__
     :undoc-members:
@@ -60,28 +60,28 @@ The following datasets are domain-specific datasets based on the |PatternDataset
 Playground
 ++++++++++
 
-.. autoclass:: playground_plums.dataflow.dataset.PlaygroundDataset
+.. autoclass:: plums.dataflow.dataset.PlaygroundDataset
     :members:
     :special-members: __getitem__, __len__
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
-.. autoclass:: playground_plums.dataflow.dataset.playground.TileDriver
+.. autoclass:: plums.dataflow.dataset.playground.TileDriver
     :members:
     :special-members: __call__
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
-.. autoclass:: playground_plums.dataflow.dataset.playground.AnnotationDriver
+.. autoclass:: plums.dataflow.dataset.playground.AnnotationDriver
     :members:
     :special-members: __call__
     :undoc-members:
     :show-inheritance:
     :member-order: bysource
 
-.. autoclass:: playground_plums.dataflow.dataset.playground.TaxonomyReader
+.. autoclass:: plums.dataflow.dataset.playground.TaxonomyReader
     :members:
     :special-members: __call__
     :undoc-members: