pysparkling -> gelanis so the docs will work. (#11)

svaningelgem · Mar 19, 2021 · b04b998 · b04b998
1 parent a8c46c1
commit b04b998
Show file tree

Hide file tree

Showing 14 changed files with 68 additions and 68 deletions.
diff --git a/docs/demo.ipynb b/docs/demo.ipynb
@@ -6,7 +6,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from pysparkling import Context"
+    "from gelanis import Context"
    ]
   },
   {
@@ -31,14 +31,14 @@
        " ('githubusercontent', 2),\n",
        " ('com', 7),\n",
        " ('svenkreiss', 7),\n",
-       " ('pysparkling', 22),\n",
+       " ('gelanis', 22),\n",
        " ('master', 4),\n",
        " ('logo', 2),\n",
        " ('w100', 1),\n",
        " ('png', 2),\n",
        " ('target', 3),\n",
        " ('github', 5),\n",
-       " ('Pysparkling', 2),\n",
+       " ('Gelanis', 2),\n",
        " ('provides', 1),\n",
        " ('a', 13),\n",
        " ('faster', 1),\n",

diff --git a/docs/iris.ipynb b/docs/iris.ipynb
@@ -13,8 +13,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import pysparkling\n",
-    "c = pysparkling.Context()"
+    "import gelanis\n",
+    "c = gelanis.Context()"
    ]
   },
   {

diff --git a/docs/sphinx/Makefile b/docs/sphinx/Makefile
@@ -84,9 +84,9 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pysparkling.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/gelanis.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pysparkling.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/gelanis.qhc"
 
 applehelp:
 	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@@ -101,8 +101,8 @@ devhelp:
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/pysparkling"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pysparkling"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/gelanis"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/gelanis"
 	@echo "# devhelp"
 
 epub:

diff --git a/docs/sphinx/api.rst b/docs/sphinx/api.rst
@@ -3,9 +3,9 @@
 API
 ===
 
-.. currentmodule:: pysparkling
+.. currentmodule:: gelanis
 
-A usual ``pysparkling`` session starts with either parallelizing a `list`
+A usual ``gelanis`` session starts with either parallelizing a `list`
 with :func:`Context.parallelize` or by reading data from a file using
 :func:`Context.textFile`. These two methods return :class:`RDD` instances that
 can then be processed.

diff --git a/docs/sphinx/api_context.rst b/docs/sphinx/api_context.rst
@@ -1,11 +1,11 @@
 .. _api_context:
 
-.. currentmodule:: pysparkling
+.. currentmodule:: gelanis
 
 Context
 -------
 
-A :class:`~pysparkling.Context` describes the setup. Instantiating a Context with the default
+A :class:`~gelanis.Context` describes the setup. Instantiating a Context with the default
 arguments using ``Context()`` is the most lightweight setup. All data is just
 in the local thread and is never serialized or deserialized.
 
@@ -16,7 +16,7 @@ a common instantiation with `multiprocessing` looks like this:
 
 .. code-block:: python
 
-  sc = pysparkling.Context(
+  sc = gelanis.Context(
       multiprocessing.Pool(4),
       serializer=cloudpickle.dumps,
       deserializer=pickle.loads,
@@ -25,5 +25,5 @@ a common instantiation with `multiprocessing` looks like this:
 This assumes that your data is serializable with `pickle` which is generally
 faster. You can also specify a custom serializer/deserializer for data.
 
-.. autoclass:: pysparkling.Context
+.. autoclass:: gelanis.Context
    :members:
diff --git a/docs/sphinx/api_fileio.rst b/docs/sphinx/api_fileio.rst
@@ -4,12 +4,12 @@
 fileio
 ------
 
-.. currentmodule:: pysparkling
+.. currentmodule:: gelanis
 
 The functionality provided by this module is used in :func:`Context.textFile`
 for reading and in :func:`RDD.saveAsTextFile` for writing.
 
-.. currentmodule:: pysparkling.fileio
+.. currentmodule:: gelanis.fileio
 
 You can use this submodule with :func:`File.dump`, :func:`File.load` and
 :func:`File.exists` to read, write and check for existance of a file.
@@ -18,61 +18,61 @@ All methods transparently handle various schemas (for example ``http://``,
 ``.bz2`` files (among others).
 
 
-.. autoclass:: pysparkling.fileio.File
+.. autoclass:: gelanis.fileio.File
     :members:
 
-.. autoclass:: pysparkling.fileio.TextFile
+.. autoclass:: gelanis.fileio.TextFile
     :members:
 
 
 File System
 ^^^^^^^^^^^
 
-.. autoclass:: pysparkling.fileio.fs.FileSystem
+.. autoclass:: gelanis.fileio.fs.FileSystem
     :members:
 
-.. autoclass:: pysparkling.fileio.fs.Local
+.. autoclass:: gelanis.fileio.fs.Local
     :members:
 
-.. autoclass:: pysparkling.fileio.fs.GS
+.. autoclass:: gelanis.fileio.fs.GS
     :members:
 
-.. autoclass:: pysparkling.fileio.fs.Hdfs
+.. autoclass:: gelanis.fileio.fs.Hdfs
     :members:
 
-.. autoclass:: pysparkling.fileio.fs.Http
+.. autoclass:: gelanis.fileio.fs.Http
     :members:
 
-.. autoclass:: pysparkling.fileio.fs.S3
+.. autoclass:: gelanis.fileio.fs.S3
     :members:
 
 
 Codec
 ^^^^^
 
-.. autoclass:: pysparkling.fileio.codec.Codec
+.. autoclass:: gelanis.fileio.codec.Codec
     :members:
 
-.. autoclass:: pysparkling.fileio.codec.Bz2
+.. autoclass:: gelanis.fileio.codec.Bz2
     :members:
 
-.. autoclass:: pysparkling.fileio.codec.Gz
+.. autoclass:: gelanis.fileio.codec.Gz
     :members:
 
-.. autoclass:: pysparkling.fileio.codec.Lzma
+.. autoclass:: gelanis.fileio.codec.Lzma
     :members:
 
-.. autoclass:: pysparkling.fileio.codec.SevenZ
+.. autoclass:: gelanis.fileio.codec.SevenZ
     :members:
 
-.. autoclass:: pysparkling.fileio.codec.Tar
+.. autoclass:: gelanis.fileio.codec.Tar
     :members:
 
-.. autoclass:: pysparkling.fileio.codec.TarGz
+.. autoclass:: gelanis.fileio.codec.TarGz
     :members:
 
-.. autoclass:: pysparkling.fileio.codec.TarBz2
+.. autoclass:: gelanis.fileio.codec.TarBz2
     :members:
 
-.. autoclass:: pysparkling.fileio.codec.Zip
+.. autoclass:: gelanis.fileio.codec.Zip
     :members:
diff --git a/docs/sphinx/api_rdd.rst b/docs/sphinx/api_rdd.rst
@@ -3,8 +3,8 @@
 RDD
 ---
 
-.. autoclass:: pysparkling.RDD
+.. autoclass:: gelanis.RDD
    :members:
 
-.. autoclass:: pysparkling.StatCounter
+.. autoclass:: gelanis.StatCounter
    :members:
diff --git a/docs/sphinx/api_streaming.rst b/docs/sphinx/api_streaming.rst
@@ -11,12 +11,12 @@ Streaming
 StreamingContext
 ^^^^^^^^^^^^^^^^
 
-.. autoclass:: pysparkling.streaming.StreamingContext
+.. autoclass:: gelanis.streaming.StreamingContext
    :members:
 
 
 DStream
 ^^^^^^^
 
-.. autoclass:: pysparkling.streaming.DStream
+.. autoclass:: gelanis.streaming.DStream
    :members:
diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# pysparkling documentation build configuration file, created by
+# gelanis documentation build configuration file, created by
 # sphinx-quickstart on Sun Jun  7 12:37:20 2015.
 #
 # This file is execfile()d with the current directory set to its
@@ -16,9 +16,9 @@
 import sys
 
 sys.path.insert(0, os.path.abspath('../..'))
-import pysparkling
+import gelanis
 
-PYSPARKLING_VERSION = pysparkling.__version__
+GELANIS_VERSION = gelanis.__version__
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -67,18 +67,18 @@
 master_doc = 'index'
 
 # General information about the project.
-project = 'pysparkling'
+project = 'gelanis'
 copyright = '2015-2021, a project started by Sven Kreiss.'
-author = 'pysparkling contributors'
+author = 'gelanis contributors'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = PYSPARKLING_VERSION
+version = GELANIS_VERSION
 # The full version, including alpha/beta/rc tags.
-release = PYSPARKLING_VERSION
+release = GELANIS_VERSION
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -223,7 +223,7 @@
 #html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'pysparklingdoc'
+htmlhelp_basename = 'gelanisdoc'
 
 
 # Example configuration for intersphinx: refer to the Python standard library.

diff --git a/docs/sphinx/dev.rst b/docs/sphinx/dev.rst
@@ -4,7 +4,7 @@ Development
 ===========
 
 Fork the Github repository and apply your changes in a feature branch.
-To run pysparkling's unit tests:
+To run gelanis's unit tests:
 
 .. code-block:: sh
 

diff --git a/docs/sphinx/parallel.rst b/docs/sphinx/parallel.rst
@@ -4,7 +4,7 @@
 Parallelization
 ===============
 
-Pysparkling supports parallelizations on the local machine and across clusters
+Gelanis supports parallelizations on the local machine and across clusters
 of computers.
 
 
@@ -22,9 +22,9 @@ serialization to support lambda functions (and more) for data transformations.
 
     import cloudpickle
     import concurrent
-    import pysparkling
+    import gelanis
 
-    sc = pysparkling.Context(
+    sc = gelanis.Context(
         pool=concurrent.futures.ProcessPoolExecutor(4),
         serializer=cloudpickle.dumps,
         deserializer=pickle.loads,
@@ -36,7 +36,7 @@ Experimental
 ------------
 
 The following are experimental notes. Most of them don't even contain examples how to make
-use of these techniques with pysparkling.
+use of these techniques with gelanis.
 
 ipcluster and IPython.parallel
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -119,7 +119,7 @@ Setup
     KEYNAME = starclusterkey
 
     # disable the queue, Sun Grid Engine
-    # (unnecessary for pysparkling and takes time during setup)
+    # (unnecessary for gelanis and takes time during setup)
     DISABLE_QUEUE=True
 
     # to enable IPython parallel support, uncomment these lines in config:

diff --git a/docs/sphinx/read_write.rst b/docs/sphinx/read_write.rst
@@ -1,6 +1,6 @@
 .. _read_write:
 
-.. currentmodule:: pysparkling
+.. currentmodule:: gelanis
 
 
 Reading and Writing
@@ -20,9 +20,9 @@ The most direct input and output is from and to a Python list.
 
 .. code-block:: python
 
-    import pysparkling
+    import gelanis
 
-    sc = pysparkling.Context()
+    sc = gelanis.Context()
 
     # reading
     rdd = sc.parallelize(['hello', 'world'])
@@ -43,9 +43,9 @@ Newline delimited JSON is a text file where every line is its own JSON string.
 .. code-block:: python
 
     import json
-    import pysparkling
+    import gelanis
 
-    sc = pysparkling.Context()
+    sc = gelanis.Context()
 
     # reading
     rdd = (
@@ -69,9 +69,9 @@ CSV
 
     import csv
     import io
-    import pysparkling
+    import gelanis
 
-    sc = pysparkling.Context()
+    sc = gelanis.Context()
 
     # reading
     rdd = (
@@ -101,7 +101,7 @@ second part is a cross check and prints the contents of the `tfrecords` file.
 
 .. code-block:: python
 
-    import pysparkling
+    import gelanis
     import tensorflow as tf
 
     def to_tfrecord(self, xy):
@@ -117,7 +117,7 @@ second part is a cross check and prints the contents of the `tfrecords` file.
     y = [2, 5]
 
     # writing
-    sc = pysparkling.Context()
+    sc = gelanis.Context()
     rdd = (
         sc
         .parallelize([(X, y)])
@@ -144,10 +144,10 @@ Python List
 
 .. code-block:: python
 
-    import pysparkling
+    import gelanis
 
-    sc = pysparkling.Context()
-    ssc = pysparkling.streaming.StreamingContext(sc, 1.0)
+    sc = gelanis.Context()
+    ssc = gelanis.streaming.StreamingContext(sc, 1.0)
 
     (
         ssc