Merge pull request #26 from nicolasaunai/readme

update package name
LaboratoryOfPlasmaPhysics · May 2, 2024 · 8567ac5 · 8567ac5
2 parents a1693d9 + fd9a536
commit 8567ac5
Show file tree

Hide file tree

Showing 23 changed files with 92 additions and 99 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -15,7 +15,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/nicolasaunai/space/issues.
+Report bugs at https://github.com/LaboratoryOfPlasmaPhysics/spok.
 
 If you are reporting a bug, please include:
 
@@ -38,14 +38,14 @@ and "help wanted" is open to whoever wants to implement it.
 Write Documentation
 ~~~~~~~~~~~~~~~~~~~
 
-space could always use more documentation, whether as part of the
-official space docs, in docstrings, or even on the web in blog posts,
+`spok` could always use more documentation, whether as part of the
+official `spok` docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/nicolasaunai/space/issues.
+The best way to send feedback is to file an issue at https://github.com/LaboratoryOfPlasmaPhysics/spok
 
 If you are proposing a feature:
 
@@ -59,15 +59,15 @@ Get Started!
 
 Ready to contribute? Here's how to set up `space` for local development.
 
-1. Fork the `space` repo on GitHub.
+1. Fork the `spok` repo on GitHub.
 2. Clone your fork locally::
 
-    $ git clone git@github.com:your_name_here/space.git
+    $ git clone git@github.com:your_name_here/spok.git
 
 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
 
-    $ mkvirtualenv space
-    $ cd space/
+    $ mkvirtualenv spok
+    $ cd spok/
     $ python setup.py develop
 
 4. Create a branch for local development::
@@ -79,7 +79,7 @@ Ready to contribute? Here's how to set up `space` for local development.
 5. When you're done making changes, check that your changes pass flake8 and the
    tests, including testing other Python versions with tox::
 
-    $ flake8 space tests
+    $ flake8 spok tests
     $ python setup.py test or pytest
     $ tox
 
@@ -103,7 +103,7 @@ Before you submit a pull request, check that it meets these guidelines:
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
 3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
-   https://travis-ci.com/nicolasaunai/space/pull_requests
+   https://github.com/LaboratoryOfPlasmaPhysics/spok/pulls
    and make sure that the tests pass for all supported Python versions.
 
 Tips
@@ -112,7 +112,7 @@ Tips
 To run a subset of tests::
 
 
-    $ python -m unittest tests.test_space
+    $ python -m unittest tests.test_spok
 
 Deploying
 ---------

diff --git a/Makefile b/Makefile
@@ -48,7 +48,7 @@ clean-test: ## remove test and coverage artifacts
 	rm -fr .pytest_cache
 
 lint: ## check style with flake8
-	flake8 space tests
+	flake8 spok tests
 
 test: ## run tests quickly with the default Python
 	python setup.py test
@@ -57,15 +57,15 @@ test-all: ## run tests on every Python version with tox
 	tox
 
 coverage: ## check code coverage quickly with the default Python
-	coverage run --source space setup.py test
+	coverage run --source spok setup.py test
 	coverage report -m
 	coverage html
 	$(BROWSER) htmlcov/index.html
 
 docs: ## generate Sphinx HTML documentation, including API docs
-	rm -f docs/space.rst
+	rm -f docs/spok.rst
 	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ space
+	sphinx-apidoc -o docs/ spok
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html

diff --git a/README.md b/README.md
@@ -1,25 +1,21 @@
-# space
+# SPOK
 
-[![PyPI](https://img.shields.io/pypi/v/space)](https://pypi.python.org/pypi/space)
-[![Tests](https://github.com/LaboratoryOfPlasmaPhysics/space/actions/workflows/test_main.yml/badge.svg)](https://github.com/LaboratoryOfPlasmaPhysics/space/actions/workflows/test_main.yml)
-[![Documentation Status](https://readthedocs.org/projects/space/badge/?version=latest)](https://space.readthedocs.io/en/latest/?badge=latest)
-[![Coverage Status](https://codecov.io/gh/LaboratoryOfPlasmaPhysics/space/branch/main/graph/badge.svg?branch=main)](https://codecov.io/gh/LaboratoryOfPlasmaPhysics/space/branch/main)
+[![PyPI](https://img.shields.io/pypi/v/spok)](https://pypi.python.org/pypi/spok)
+[![Tests](https://github.com/LaboratoryOfPlasmaPhysics/spok/actions/workflows/test_main.yml/badge.svg)](https://github.com/LaboratoryOfPlasmaPhysics/spok/actions/workflows/test_main.yml)
+[![Documentation Status](https://readthedocs.org/projects/spok/badge/?version=latest)](https://spok.readthedocs.io/en/latest/?badge=latest)
+[![Coverage Status](https://codecov.io/gh/LaboratoryOfPlasmaPhysics/spok/branch/main/graph/badge.svg?branch=main)](https://codecov.io/gh/LaboratoryOfPlasmaPhysics/spok/branch/main)
 
-Space Plasma Analysis CodE
+spok Plasma Observations Kit
 
-![space](https://user-images.githubusercontent.com/3200931/98716891-978e2180-238c-11eb-9487-07c66221e5bb.png)
+![spok](https://user-images.githubusercontent.com/3200931/98716891-978e2180-238c-11eb-9487-07c66221e5bb.png)
 
 
 * Free software: GNU General Public License v3
-* Documentation: https://space.readthedocs.io.
+* Documentation: https://spok.readthedocs.io.
 
 
 ## Features
 
 
 ## TODO
 
-## Credits
-
-
-This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template.
diff --git a/docs/Makefile b/docs/Makefile
@@ -4,7 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = python -msphinx
-SPHINXPROJ    = space
+SPHINXPROJ    = spok
 SOURCEDIR     = .
 BUILDDIR      = _build
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# space documentation build configuration file, created by
+# spok documentation build configuration file, created by
 # sphinx-quickstart on Fri Jun  9 13:47:02 2017.
 #
 # This file is execfile()d with the current directory set to its
@@ -19,9 +19,10 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
 
-import space
+sys.path.insert(0, os.path.abspath(".."))
+
+import spok
 
 # -- General configuration ---------------------------------------------
 
@@ -31,22 +32,22 @@
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'space'
+project = "spok"
 copyright = "2020, Nicolas Aunai"
 author = "Nicolas Aunai"
 
@@ -55,9 +56,9 @@
 # the built documents.
 #
 # The short X.Y version.
-version = space.__version__
+version = spok.__version__
 # The full version, including alpha/beta/rc tags.
-release = space.__version__
+release = spok.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -69,10 +70,10 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -83,7 +84,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # Theme options are theme-specific and customize the look and feel of a
 # theme further.  For a list of options available for each theme, see the
@@ -94,13 +95,13 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 
 # -- Options for HTMLHelp output ---------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'spacedoc'
+htmlhelp_basename = "spokdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------
@@ -109,15 +110,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -127,21 +125,15 @@
 # (source start file, target name, title, author, documentclass
 # [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'space.tex',
-     'space Documentation',
-     'Nicolas Aunai', 'manual'),
+    (master_doc, "spok.tex", "spok Documentation", "Nicolas Aunai", "manual"),
 ]
 
 
 # -- Options for manual page output ------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'space',
-     'space Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "spok", "spok Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------
@@ -150,13 +142,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'space',
-     'space Documentation',
-     author,
-     'space',
-     'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "spok",
+        "spok Documentation",
+        author,
+        "spok",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
-
-
-
diff --git a/pyproject.toml b/pyproject.toml
@@ -3,10 +3,10 @@ build-backend = "flit_core.buildapi"
 requires = ["flit_core"]
 
 [project]
-name = "space"
+name = "spok"
 version = "0.1.0"
-description = "Space Plasma Analysis CodE"
-keywords = ["space", "plasma-physics"]
+description = "Space Plasmas Observations Kit"
+keywords = ["spok", "plasma-physics"]
 authors = [
     { name = "Nicolas Aunai", email = "nicolas.aunai@lpp.polytechnique.fr" }
 ]
@@ -33,6 +33,6 @@ classifiers = [
 ]
 dependencies = ["pandas", "numpy", "matplotlib", "scipy"]
 [project.urls]
-homepage = "https://github.com/LaboratoryOfPlasmaPhysics/space"
+homepage = "https://github.com/LaboratoryOfPlasmaPhysics/spok"
 
 
diff --git a/setup.cfg b/setup.cfg
@@ -7,7 +7,7 @@ tag = True
 search = version = "{current_version}"
 replace = version = "{new_version}"
 
-[bumpversion:file:space/__init__.py]
+[bumpversion:file:spok/__init__.py]
 search = __version__ = '{current_version}'
 replace = __version__ = '{new_version}'
 

diff --git a/space/__init__.py b/space/__init__.py
diff --git a/spok/__init__.py b/spok/__init__.py
@@ -0,0 +1,5 @@
+"""Top-level package for spok."""
+
+__author__ = """Nicolas Aunai"""
+__email__ = "nicolas.aunai@lpp.polytechnique.fr"
+__version__ = "0.1.0"
diff --git a/space/analysis/mva.py → spok/analysis/mva.py b/space/analysis/mva.py → spok/analysis/mva.py
diff --git a/space/coordinates/__init__.py → spok/coordinates/__init__.py b/space/coordinates/__init__.py → spok/coordinates/__init__.py
diff --git a/space/coordinates/coordinates.py → spok/coordinates/coordinates.py b/space/coordinates/coordinates.py → spok/coordinates/coordinates.py
diff --git a/space/data/__init__.py → spok/data/__init__.py b/space/data/__init__.py → spok/data/__init__.py
diff --git a/space/models/__init__.py → spok/models/__init__.py b/space/models/__init__.py → spok/models/__init__.py
diff --git a/space/models/planetary.py → spok/models/planetary.py b/space/models/planetary.py → spok/models/planetary.py
diff --git a/space/plot/__init__.py → spok/plot/__init__.py b/space/plot/__init__.py → spok/plot/__init__.py
diff --git a/space/plot/planet_env.py → spok/plot/planet_env.py b/space/plot/planet_env.py → spok/plot/planet_env.py
diff --git a/space/smath.py → spok/smath.py b/space/smath.py → spok/smath.py
diff --git a/space/space.py → spok/spok.py b/space/space.py → spok/spok.py
diff --git a/space/utils.py → spok/utils.py b/space/utils.py → spok/utils.py
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -1 +1 @@
-"""Unit test package for space."""
+"""Unit test package for spok."""
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		"""Unit test package for space."""
		"""Unit test package for spok."""