Merge pull request #3 from scipp/update-name

Update project name

.copier-answers.yml

@@ -1,13 +1,13 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
 _commit: 4180f34
 _src_path: gh:scipp/copier_template
-description: Python application craft helper tools.
+description: Python application construction helper.
 max_python: '3.12'
 min_python: '3.10'
 namespace_package: ''
-nightly_deps: ''
+nightly_deps: Textualize/rich
 orgname: scipp
-prettyname: App Crafter
-projectname: app-crafter
+prettyname: Appstract
+projectname: appstract
 related_projects: ''
 year: 2024

CONTRIBUTING.md

@@ -1,20 +1,20 @@
-## Contributing to App Crafter
+## Contributing to Appstract
 
-Welcome to the developer side of App Crafter!
+Welcome to the developer side of Appstract!
 
 Contributions are always welcome.
 This includes reporting bugs or other issues, submitting pull requests, requesting new features, etc.
 
-If you need help with using App Crafter or contributing to it, have a look at the GitHub [discussions](https://github.com/scipp/app-crafter/discussions) and start a new [Q&A discussion](https://github.com/scipp/app-crafter/discussions/categories/q-a) if you can't find what you are looking for.
+If you need help with using Appstract or contributing to it, have a look at the GitHub [discussions](https://github.com/scipp/appstract/discussions) and start a new [Q&A discussion](https://github.com/scipp/appstract/discussions/categories/q-a) if you can't find what you are looking for.
 
-For bug reports and other problems, please open an [issue](https://github.com/scipp/app-crafter/issues/new) in GitHub.
+For bug reports and other problems, please open an [issue](https://github.com/scipp/appstract/issues/new) in GitHub.
 
 You are welcome to submit pull requests at any time.
 But to avoid having to make large modifications during review or even have your PR rejected, please first open an issue first to discuss your idea!
 
-Check out the subsections of the [Developer documentation](https://scipp.github.io/app-crafter/developer/index.html) for details on how App Crafter is developed.
+Check out the subsections of the [Developer documentation](https://scipp.github.io/appstract/developer/index.html) for details on how Appstract is developed.
 
 ## Code of conduct
 
 This project is a community effort, and everyone is welcome to contribute.
-Everyone within the community is expected to abide by our [code of conduct](https://github.com/scipp/app-crafter/blob/main/CODE_OF_CONDUCT.md).
+Everyone within the community is expected to abide by our [code of conduct](https://github.com/scipp/appstract/blob/main/CODE_OF_CONDUCT.md).

README.md

@@ -1,16 +1,16 @@
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
-[![PyPI badge](http://img.shields.io/pypi/v/app-crafter.svg)](https://pypi.python.org/pypi/app-crafter)
-[![Anaconda-Server Badge](https://anaconda.org/scipp/app-crafter/badges/version.svg)](https://anaconda.org/scipp/app-crafter)
+[![PyPI badge](http://img.shields.io/pypi/v/appstract.svg)](https://pypi.python.org/pypi/appstract)
+[![Anaconda-Server Badge](https://anaconda.org/scipp/appstract/badges/version.svg)](https://anaconda.org/scipp/appstract)
 [![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE)
 
-# App Crafter
+# Appstract
 
 ## About
 
-Python application craft helper tools.
+Python application construction helper.
 
 ## Installation
 
 ```sh
-python -m pip install app-crafter
+python -m pip install appstract
 ```

conda/meta.yaml

@@ -1,5 +1,5 @@
 package:
-  name: app-crafter
+  name: appstract
 
   version: {{ GIT_DESCRIBE_TAG }}
 
@@ -27,7 +27,7 @@ requirements:
 
 test:
   imports:
-    - app-crafter
+    - appstract
   requires:
 
   {# Conda does not allow spaces between package name and version, so remove them #}
@@ -49,9 +49,9 @@ build:
     - python -m pip install .
 
 about:
-  home: https://github.com/scipp/app-crafter
+  home: https://github.com/scipp/appstract
   license: BSD-3-Clause
-  summary: Python application craft helper tools.
-  description: Python application craft helper tools.
-  dev_url: https://github.com/scipp/app-crafter
-  doc_url: https://scipp.github.io/app-crafter
+  summary: Python application construction helper.
+  description: Python application construction helper.
+  dev_url: https://github.com/scipp/appstract
+  doc_url: https://scipp.github.io/appstract

docs/_templates/doc_version.html

@@ -1,2 +1,2 @@
 <!-- This will display the version of the docs -->
-Current App Crafter version: {{ version }} (<a href="https://github.com/scipp/app-crafter/releases">older versions</a>).
+Current Appstract version: {{ version }} (<a href="https://github.com/scipp/appstract/releases">older versions</a>).

docs/about/index.md

@@ -2,25 +2,25 @@
 
 ## Development
 
-App Crafter is an open source project by the [European Spallation Source ERIC](https://europeanspallationsource.se/) (ESS).
+Appstract is an open source project by the [European Spallation Source ERIC](https://europeanspallationsource.se/) (ESS).
 
 ## License
 
-App Crafter is available as open source under the [BSD-3 license](https://opensource.org/licenses/BSD-3-Clause).
+Appstract is available as open source under the [BSD-3 license](https://opensource.org/licenses/BSD-3-Clause).
 
-## Citing App Crafter
+## Citing Appstract
 
 Please cite the following:
 
 [![DOI](https://zenodo.org/badge/FIXME.svg)](https://zenodo.org/doi/10.5281/zenodo.FIXME)
 
-To cite a specific version of App Crafter, select the desired version on Zenodo to get the corresponding DOI.
+To cite a specific version of Appstract, select the desired version on Zenodo to get the corresponding DOI.
 
 ## Older versions of the documentation
 
-Older versions of the documentation pages can be found under the assets of each [release](https://github.com/scipp/app-crafter/releases).
+Older versions of the documentation pages can be found under the assets of each [release](https://github.com/scipp/appstract/releases).
 Simply download the archive, unzip and view locally in a web browser.
 
 ## Source code and development
 
-App Crafter is hosted and developed [on GitHub](https://github.com/scipp/app-crafter).
+Appstract is hosted and developed [on GitHub](https://github.com/scipp/appstract).

docs/api-reference/index.md

@@ -3,7 +3,7 @@
 ## Classes
 
 ```{eval-rst}
-.. currentmodule:: app-crafter
+.. currentmodule:: appstract
 
 .. autosummary::
    :toctree: ../generated/classes

docs/conf.py

@@ -14,7 +14,7 @@
 logger = logging.getLogger(__name__)
 
 # General information about the project.
-project = 'App Crafter'
+project = 'Appstract'
 copyright = '2024 Scipp contributors'
 author = 'Scipp contributors'
 
@@ -91,7 +91,7 @@
 typehints_use_rtype = False
 
 
-sciline_domain_types_prefix = 'app-crafter'
+sciline_domain_types_prefix = 'appstract'
 sciline_domain_types_aliases = {
     'scipp._scipp.core.DataArray': 'scipp.DataArray',
     'scipp._scipp.core.Dataset': 'scipp.Dataset',
@@ -120,7 +120,7 @@
 #
 
 try:
-    release = get_version("app-crafter")
+    release = get_version("appstract")
     version = ".".join(release.split('.')[:3])  # CalVer
 except PackageNotFoundError:
     logger.info(
@@ -171,19 +171,19 @@
     "icon_links": [
         {
             "name": "GitHub",
-            "url": "https://github.com/scipp/app-crafter",
+            "url": "https://github.com/scipp/appstract",
             "icon": "fa-brands fa-github",
             "type": "fontawesome",
         },
         {
             "name": "PyPI",
-            "url": "https://pypi.org/project/app-crafter/",
+            "url": "https://pypi.org/project/appstract/",
             "icon": "fa-brands fa-python",
             "type": "fontawesome",
         },
         {
             "name": "Conda",
-            "url": "https://anaconda.org/scipp/app-crafter",
+            "url": "https://anaconda.org/scipp/appstract",
             "icon": "fa-custom fa-anaconda",
             "type": "fontawesome",
         },
@@ -198,7 +198,7 @@
     "**": ["sidebar-nav-bs", "page-toc"],
 }
 
-html_title = "App Crafter"
+html_title = "Appstract"
 html_logo = "_static/logo.svg"
 html_favicon = "_static/favicon.ico"
 
@@ -212,7 +212,7 @@
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'app-crafterdoc'
+htmlhelp_basename = 'appstractdoc'
 
 # -- Options for Matplotlib in notebooks ----------------------------------
 

docs/developer/dependency-management.md

@@ -1,6 +1,6 @@
 # Dependency management
 
-app-crafter is a library, so the package dependencies are never pinned.
+appstract is a library, so the package dependencies are never pinned.
 Lower bounds are fine and individual versions can be excluded.
 See, e.g., [Should You Use Upper Bound Version Constraints](https://iscinumpy.dev/post/bound-version-constraints/) for an explanation.
 

docs/index.md

@@ -1,7 +1,7 @@
-# App Crafter
+# Appstract
 
 <span style="font-size:1.2em;font-style:italic;color:#5a5a5a">
-  Python application craft helper tools.
+  Python application construction helper.
   </br></br>
 </span>
 

pyproject.toml

@@ -6,8 +6,8 @@ requires = [
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "app-crafter"
-description = "Python application craft helper tools."
+name = "appstract"
+description = "Python application construction helper."
 authors = [{ name = "Scipp contributors" }]
 license = { file = "LICENSE" }
 readme = "README.md"
@@ -42,9 +42,9 @@ test = [
 ]
 
 [project.urls]
-"Bug Tracker" = "https://github.com/scipp/app-crafter/issues"
-"Documentation" = "https://scipp.github.io/app-crafter"
-"Source" = "https://github.com/scipp/app-crafter"
+"Bug Tracker" = "https://github.com/scipp/appstract/issues"
+"Documentation" = "https://scipp.github.io/appstract"
+"Source" = "https://github.com/scipp/appstract"
 
 [tool.setuptools_scm]
 
@@ -78,7 +78,7 @@ ignore = [
     "COM812", "COM819", "D206", "D300", "E111", "E114", "E117", "ISC001", "ISC002", "Q000", "Q001", "Q002", "Q003", "W191",
 ]
 fixable = ["B010", "I001", "PT001", "RUF022"]
-isort.known-first-party = ["app-crafter"]
+isort.known-first-party = ["appstract"]
 pydocstyle.convention = "numpy"
 
 [tool.ruff.lint.per-file-ignores]

src/app_crafter/constructors/providers.py → src/appstract/constructors/providers.py

@@ -634,7 +634,7 @@ def provider(
 
         Examples
         --------
-        >>> from app_crafter.constructors import ProviderGroup
+        >>> from appstract.constructors import ProviderGroup
         >>> from typing import Literal
         >>> number_providers = ProviderGroup()
         >>> @number_providers.provider

src/app_crafter/logging/formatters.py → src/appstract/logging/formatters.py

@@ -34,7 +34,7 @@ class LogColumn:
 
     Examples
     --------
-    >>> from app_crafter.logging.formatters import LogColumn
+    >>> from appstract.logging.formatters import LogColumn
     >>> time_column = LogColumn(variable_name='asctime',
     ... min_length=8, title='TIME', style='{')
     >>> time_column.formatter
@@ -94,7 +94,7 @@ class LogHeader(OrderedDict[str, LogColumn]):
 
     Examples
     --------
-    >>> from app_crafter.logging.formatters import LogHeader, LogColumn
+    >>> from appstract.logging.formatters import LogHeader, LogColumn
     >>> time_column = LogColumn(variable_name='asctime',
     ... min_length=8, title='TIME', style='{')
     >>> app_name_column = LogColumn(variable_name='app_name',

src/app_crafter/logging/handlers.py → src/appstract/logging/handlers.py

@@ -20,7 +20,7 @@ def __del__(self) -> None:
 
 
 @_handler_providers.provider
-def provide_app_crafter_filehandler(
+def provide_appstract_filehandler(
     filename: FileHandlerBasePath, formatter: AppCrafterFileFormatter
 ) -> AppCrafterFileHandler:
     """Returns a file handler."""
@@ -33,7 +33,7 @@ class AppCrafterStreamHandler(RichHandler): ...
 
 
 @_handler_providers.provider
-def provide_app_crafter_streamhandler(
+def provide_appstract_streamhandler(
     highlighter: AppCrafterStreamHighlighter,
 ) -> AppCrafterStreamHandler:
     """Returns a ``RichHandler`` with :py:class:``AppCrafterStreamHighlighter``."""

src/app_crafter/logging/providers.py → src/appstract/logging/providers.py

@@ -28,7 +28,7 @@ def get_logger(
     Retrieves a default logger and add ``stream_handler`` if ``verbose``.
 
     """
-    from app_crafter import __name__ as default_name
+    from appstract import __name__ as default_name
 
     logger = logging.getLogger(default_name)
     if verbose and not logger.handlers:

tests/conftest.py

@@ -7,7 +7,7 @@
 
 import pytest
 
-from app_crafter.constructors import Factory
+from appstract.constructors import Factory
 
 
 def pytest_addoption(parser: pytest.Parser):
@@ -32,15 +32,15 @@ def local_logger() -> Generator[Literal[True], None, None]:
 
     It will help a test not to interfere other tests.
     """
-    from app_crafter.logging._test_helpers import local_logger as _local_logger
+    from appstract.logging._test_helpers import local_logger as _local_logger
 
     with _local_logger():
         yield True
 
 
 @pytest.fixture
 def default_factory() -> Factory:
-    """Returns a Factory that has all default providers of ``app_crafter``."""
-    from app_crafter.logging.providers import log_providers
+    """Returns a Factory that has all default providers of ``appstract``."""
+    from appstract.logging.providers import log_providers
 
     return Factory(log_providers)

tests/constructors/factory_test.py

@@ -6,13 +6,13 @@
 
 import pytest
 
-from app_crafter.constructors import (
+from appstract.constructors import (
     Factory,
     ProviderGroup,
     ProviderNotFoundError,
     SingletonProvider,
 )
-from app_crafter.constructors._test_helpers import (
+from appstract.constructors._test_helpers import (
     Adult,
     GoodTelling,
     Joke,

tests/constructors/inspection_test.py

@@ -3,8 +3,8 @@
 
 import pytest
 
-from app_crafter.constructors import Empty, UnknownType
-from app_crafter.constructors.inspectors import DependencySpec, ProductSpec
+from appstract.constructors import Empty, UnknownType
+from appstract.constructors.inspectors import DependencySpec, ProductSpec
 
 
 def test_product_spec_compare():

tests/constructors/provider_context_test.py

@@ -4,13 +4,13 @@
 
 import pytest
 
-from app_crafter.constructors import (
+from appstract.constructors import (
     Factory,
     MismatchingProductTypeError,
     ProviderGroup,
     ProviderNotFoundError,
 )
-from app_crafter.constructors._test_helpers import (
+from appstract.constructors._test_helpers import (
     Adult,
     GoodTelling,
     Joke,

tests/constructors/provider_decorator_test.py

@@ -4,8 +4,8 @@
 
 import pytest
 
-from app_crafter.constructors import Factory, Provider, ProviderGroup, SingletonProvider
-from app_crafter.constructors._test_helpers import orange_joke
+from appstract.constructors import Factory, Provider, ProviderGroup, SingletonProvider
+from appstract.constructors._test_helpers import orange_joke
 
 decorating_provider_group = ProviderGroup()
 UsefulString = NewType("UsefulString", str)