Skip to content

Commit b04b998

Browse files
authored
pysparkling -> gelanis so the docs will work. (#11)
1 parent a8c46c1 commit b04b998

File tree

14 files changed

+68
-68
lines changed

14 files changed

+68
-68
lines changed

docs/demo.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"metadata": {},
77
"outputs": [],
88
"source": [
9-
"from pysparkling import Context"
9+
"from gelanis import Context"
1010
]
1111
},
1212
{
@@ -31,14 +31,14 @@
3131
" ('githubusercontent', 2),\n",
3232
" ('com', 7),\n",
3333
" ('svenkreiss', 7),\n",
34-
" ('pysparkling', 22),\n",
34+
" ('gelanis', 22),\n",
3535
" ('master', 4),\n",
3636
" ('logo', 2),\n",
3737
" ('w100', 1),\n",
3838
" ('png', 2),\n",
3939
" ('target', 3),\n",
4040
" ('github', 5),\n",
41-
" ('Pysparkling', 2),\n",
41+
" ('Gelanis', 2),\n",
4242
" ('provides', 1),\n",
4343
" ('a', 13),\n",
4444
" ('faster', 1),\n",

docs/iris.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
"metadata": {},
1414
"outputs": [],
1515
"source": [
16-
"import pysparkling\n",
17-
"c = pysparkling.Context()"
16+
"import gelanis\n",
17+
"c = gelanis.Context()"
1818
]
1919
},
2020
{

docs/sphinx/Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ qthelp:
8484
@echo
8585
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
8686
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
87-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pysparkling.qhcp"
87+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/gelanis.qhcp"
8888
@echo "To view the help file:"
89-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pysparkling.qhc"
89+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/gelanis.qhc"
9090

9191
applehelp:
9292
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@@ -101,8 +101,8 @@ devhelp:
101101
@echo
102102
@echo "Build finished."
103103
@echo "To view the help file:"
104-
@echo "# mkdir -p $$HOME/.local/share/devhelp/pysparkling"
105-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pysparkling"
104+
@echo "# mkdir -p $$HOME/.local/share/devhelp/gelanis"
105+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/gelanis"
106106
@echo "# devhelp"
107107

108108
epub:

docs/sphinx/api.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
API
44
===
55

6-
.. currentmodule:: pysparkling
6+
.. currentmodule:: gelanis
77

8-
A usual ``pysparkling`` session starts with either parallelizing a `list`
8+
A usual ``gelanis`` session starts with either parallelizing a `list`
99
with :func:`Context.parallelize` or by reading data from a file using
1010
:func:`Context.textFile`. These two methods return :class:`RDD` instances that
1111
can then be processed.

docs/sphinx/api_context.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
.. _api_context:
22

3-
.. currentmodule:: pysparkling
3+
.. currentmodule:: gelanis
44

55
Context
66
-------
77

8-
A :class:`~pysparkling.Context` describes the setup. Instantiating a Context with the default
8+
A :class:`~gelanis.Context` describes the setup. Instantiating a Context with the default
99
arguments using ``Context()`` is the most lightweight setup. All data is just
1010
in the local thread and is never serialized or deserialized.
1111

@@ -16,7 +16,7 @@ a common instantiation with `multiprocessing` looks like this:
1616

1717
.. code-block:: python
1818
19-
sc = pysparkling.Context(
19+
sc = gelanis.Context(
2020
multiprocessing.Pool(4),
2121
serializer=cloudpickle.dumps,
2222
deserializer=pickle.loads,
@@ -25,5 +25,5 @@ a common instantiation with `multiprocessing` looks like this:
2525
This assumes that your data is serializable with `pickle` which is generally
2626
faster. You can also specify a custom serializer/deserializer for data.
2727

28-
.. autoclass:: pysparkling.Context
28+
.. autoclass:: gelanis.Context
2929
:members:

docs/sphinx/api_fileio.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
fileio
55
------
66

7-
.. currentmodule:: pysparkling
7+
.. currentmodule:: gelanis
88

99
The functionality provided by this module is used in :func:`Context.textFile`
1010
for reading and in :func:`RDD.saveAsTextFile` for writing.
1111

12-
.. currentmodule:: pysparkling.fileio
12+
.. currentmodule:: gelanis.fileio
1313

1414
You can use this submodule with :func:`File.dump`, :func:`File.load` and
1515
: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://``,
1818
``.bz2`` files (among others).
1919

2020

21-
.. autoclass:: pysparkling.fileio.File
21+
.. autoclass:: gelanis.fileio.File
2222
:members:
2323

24-
.. autoclass:: pysparkling.fileio.TextFile
24+
.. autoclass:: gelanis.fileio.TextFile
2525
:members:
2626

2727

2828
File System
2929
^^^^^^^^^^^
3030

31-
.. autoclass:: pysparkling.fileio.fs.FileSystem
31+
.. autoclass:: gelanis.fileio.fs.FileSystem
3232
:members:
3333

34-
.. autoclass:: pysparkling.fileio.fs.Local
34+
.. autoclass:: gelanis.fileio.fs.Local
3535
:members:
3636

37-
.. autoclass:: pysparkling.fileio.fs.GS
37+
.. autoclass:: gelanis.fileio.fs.GS
3838
:members:
3939

40-
.. autoclass:: pysparkling.fileio.fs.Hdfs
40+
.. autoclass:: gelanis.fileio.fs.Hdfs
4141
:members:
4242

43-
.. autoclass:: pysparkling.fileio.fs.Http
43+
.. autoclass:: gelanis.fileio.fs.Http
4444
:members:
4545

46-
.. autoclass:: pysparkling.fileio.fs.S3
46+
.. autoclass:: gelanis.fileio.fs.S3
4747
:members:
4848

4949

5050
Codec
5151
^^^^^
5252

53-
.. autoclass:: pysparkling.fileio.codec.Codec
53+
.. autoclass:: gelanis.fileio.codec.Codec
5454
:members:
5555

56-
.. autoclass:: pysparkling.fileio.codec.Bz2
56+
.. autoclass:: gelanis.fileio.codec.Bz2
5757
:members:
5858

59-
.. autoclass:: pysparkling.fileio.codec.Gz
59+
.. autoclass:: gelanis.fileio.codec.Gz
6060
:members:
6161

62-
.. autoclass:: pysparkling.fileio.codec.Lzma
62+
.. autoclass:: gelanis.fileio.codec.Lzma
6363
:members:
6464

65-
.. autoclass:: pysparkling.fileio.codec.SevenZ
65+
.. autoclass:: gelanis.fileio.codec.SevenZ
6666
:members:
6767

68-
.. autoclass:: pysparkling.fileio.codec.Tar
68+
.. autoclass:: gelanis.fileio.codec.Tar
6969
:members:
7070

71-
.. autoclass:: pysparkling.fileio.codec.TarGz
71+
.. autoclass:: gelanis.fileio.codec.TarGz
7272
:members:
7373

74-
.. autoclass:: pysparkling.fileio.codec.TarBz2
74+
.. autoclass:: gelanis.fileio.codec.TarBz2
7575
:members:
7676

77-
.. autoclass:: pysparkling.fileio.codec.Zip
77+
.. autoclass:: gelanis.fileio.codec.Zip
7878
:members:

docs/sphinx/api_rdd.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
RDD
44
---
55

6-
.. autoclass:: pysparkling.RDD
6+
.. autoclass:: gelanis.RDD
77
:members:
88

9-
.. autoclass:: pysparkling.StatCounter
9+
.. autoclass:: gelanis.StatCounter
1010
:members:

docs/sphinx/api_streaming.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ Streaming
1111
StreamingContext
1212
^^^^^^^^^^^^^^^^
1313

14-
.. autoclass:: pysparkling.streaming.StreamingContext
14+
.. autoclass:: gelanis.streaming.StreamingContext
1515
:members:
1616

1717

1818
DStream
1919
^^^^^^^
2020

21-
.. autoclass:: pysparkling.streaming.DStream
21+
.. autoclass:: gelanis.streaming.DStream
2222
:members:

docs/sphinx/conf.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22
#
3-
# pysparkling documentation build configuration file, created by
3+
# gelanis documentation build configuration file, created by
44
# sphinx-quickstart on Sun Jun 7 12:37:20 2015.
55
#
66
# This file is execfile()d with the current directory set to its
@@ -16,9 +16,9 @@
1616
import sys
1717

1818
sys.path.insert(0, os.path.abspath('../..'))
19-
import pysparkling
19+
import gelanis
2020

21-
PYSPARKLING_VERSION = pysparkling.__version__
21+
GELANIS_VERSION = gelanis.__version__
2222

2323
# If extensions (or modules to document with autodoc) are in another directory,
2424
# add these directories to sys.path here. If the directory is relative to the
@@ -67,18 +67,18 @@
6767
master_doc = 'index'
6868

6969
# General information about the project.
70-
project = 'pysparkling'
70+
project = 'gelanis'
7171
copyright = '2015-2021, a project started by Sven Kreiss.'
72-
author = 'pysparkling contributors'
72+
author = 'gelanis contributors'
7373

7474
# The version info for the project you're documenting, acts as replacement for
7575
# |version| and |release|, also used in various other places throughout the
7676
# built documents.
7777
#
7878
# The short X.Y version.
79-
version = PYSPARKLING_VERSION
79+
version = GELANIS_VERSION
8080
# The full version, including alpha/beta/rc tags.
81-
release = PYSPARKLING_VERSION
81+
release = GELANIS_VERSION
8282

8383
# The language for content autogenerated by Sphinx. Refer to documentation
8484
# for a list of supported languages.
@@ -223,7 +223,7 @@
223223
#html_search_scorer = 'scorer.js'
224224

225225
# Output file base name for HTML help builder.
226-
htmlhelp_basename = 'pysparklingdoc'
226+
htmlhelp_basename = 'gelanisdoc'
227227

228228

229229
# Example configuration for intersphinx: refer to the Python standard library.

docs/sphinx/dev.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Development
44
===========
55

66
Fork the Github repository and apply your changes in a feature branch.
7-
To run pysparkling's unit tests:
7+
To run gelanis's unit tests:
88

99
.. code-block:: sh
1010

docs/sphinx/parallel.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Parallelization
55
===============
66

7-
Pysparkling supports parallelizations on the local machine and across clusters
7+
Gelanis supports parallelizations on the local machine and across clusters
88
of computers.
99

1010

@@ -22,9 +22,9 @@ serialization to support lambda functions (and more) for data transformations.
2222
2323
import cloudpickle
2424
import concurrent
25-
import pysparkling
25+
import gelanis
2626
27-
sc = pysparkling.Context(
27+
sc = gelanis.Context(
2828
pool=concurrent.futures.ProcessPoolExecutor(4),
2929
serializer=cloudpickle.dumps,
3030
deserializer=pickle.loads,
@@ -36,7 +36,7 @@ Experimental
3636
------------
3737

3838
The following are experimental notes. Most of them don't even contain examples how to make
39-
use of these techniques with pysparkling.
39+
use of these techniques with gelanis.
4040

4141
ipcluster and IPython.parallel
4242
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -119,7 +119,7 @@ Setup
119119
KEYNAME = starclusterkey
120120
121121
# disable the queue, Sun Grid Engine
122-
# (unnecessary for pysparkling and takes time during setup)
122+
# (unnecessary for gelanis and takes time during setup)
123123
DISABLE_QUEUE=True
124124
125125
# to enable IPython parallel support, uncomment these lines in config:

docs/sphinx/read_write.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _read_write:
22

3-
.. currentmodule:: pysparkling
3+
.. currentmodule:: gelanis
44

55

66
Reading and Writing
@@ -20,9 +20,9 @@ The most direct input and output is from and to a Python list.
2020

2121
.. code-block:: python
2222
23-
import pysparkling
23+
import gelanis
2424
25-
sc = pysparkling.Context()
25+
sc = gelanis.Context()
2626
2727
# reading
2828
rdd = sc.parallelize(['hello', 'world'])
@@ -43,9 +43,9 @@ Newline delimited JSON is a text file where every line is its own JSON string.
4343
.. code-block:: python
4444
4545
import json
46-
import pysparkling
46+
import gelanis
4747
48-
sc = pysparkling.Context()
48+
sc = gelanis.Context()
4949
5050
# reading
5151
rdd = (
@@ -69,9 +69,9 @@ CSV
6969
7070
import csv
7171
import io
72-
import pysparkling
72+
import gelanis
7373
74-
sc = pysparkling.Context()
74+
sc = gelanis.Context()
7575
7676
# reading
7777
rdd = (
@@ -101,7 +101,7 @@ second part is a cross check and prints the contents of the `tfrecords` file.
101101

102102
.. code-block:: python
103103
104-
import pysparkling
104+
import gelanis
105105
import tensorflow as tf
106106
107107
def to_tfrecord(self, xy):
@@ -117,7 +117,7 @@ second part is a cross check and prints the contents of the `tfrecords` file.
117117
y = [2, 5]
118118
119119
# writing
120-
sc = pysparkling.Context()
120+
sc = gelanis.Context()
121121
rdd = (
122122
sc
123123
.parallelize([(X, y)])
@@ -144,10 +144,10 @@ Python List
144144

145145
.. code-block:: python
146146
147-
import pysparkling
147+
import gelanis
148148
149-
sc = pysparkling.Context()
150-
ssc = pysparkling.streaming.StreamingContext(sc, 1.0)
149+
sc = gelanis.Context()
150+
ssc = gelanis.streaming.StreamingContext(sc, 1.0)
151151
152152
(
153153
ssc

0 commit comments

Comments
 (0)