Merge pull request #56 from atomscale-ai/package_rename

Package rename

Author: munrojm

MANIFEST.in

@@ -1,7 +1,8 @@
+graft src/atomscale
 graft src/atomicds
 
-include src/atomicds/streaming/Cargo.toml
-recursive-include src/atomicds/streaming/src *.rs
+include src/atomscale/streaming/Cargo.toml
+recursive-include src/atomscale/streaming/src *.rs
 
-prune src/atomicds/streaming/target
+prune src/atomscale/streaming/target
 prune **/target

README.md

@@ -6,3 +6,12 @@
 [![License](https://img.shields.io/badge/License-GPLv3-blue)](#license)
 
 [![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](https://atomscale-ai.github.io/sdk/)
+
+## Install
+
+```bash
+pip install atomscale
+```
+
+> The package was renamed from `atomicds`. Importing `atomicds` (or installing
+> `atomicds`) still works via a thin shim but emits a `DeprecationWarning`.

atomicds-shim-dist/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["setuptools", "setuptools-scm", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "atomicds"
+description = "Legacy shim package that depends on atomscale."
+dynamic = ["version"]
+readme = "../README.md"
+license = { text = "GPL-3.0-only" }
+authors = [{ name = "Atomscale", email = "info@atomscale.ai" }]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Operating System :: Microsoft :: Windows",
+  "Operating System :: Unix",
+  "Operating System :: MacOS",
+]
+requires-python = ">=3.10, <3.13"
+dependencies = ["atomscale>=0"]
+
+[project.urls]
+Homepage = "https://www.atomscale.ai"
+Documentation = "https://atomscale-ai.github.io/sdk"
+
+[tool.setuptools_scm]
+root = ".."
+
+[tool.setuptools]
+package-dir = { "" = "../src" }
+
+[tool.setuptools.packages.find]
+where = ["../src"]
+include = ["atomicds"]

docs/conf.py

@@ -8,7 +8,7 @@
 SRC_DIR = PROJECT_ROOT / "src"
 sys.path.insert(0, str(SRC_DIR))
 
-project = "atomicds"
+project = "atomscale"
 copyright = "2025, Atomscale"
 author = "Atomscale"
 release = "2025"
@@ -117,7 +117,7 @@
 man_pages = [
     (
         master_doc,
-        "atomicds",
+        "atomscale",
         "Atomscale API Client Documentation",
         [author],
         1,
@@ -133,10 +133,10 @@
 texinfo_documents = [
     (
         master_doc,
-        "atomicds",
+        "atomscale",
         "Atomscale API Client Documentation",
         author,
-        "atomicds",
+        "atomscale",
         "Atomscale API.",
         "",
     ),

docs/guides/index.rst

@@ -1,7 +1,7 @@
 User Guides
 ===========
 
-Concise walkthroughs for the most common `atomicds` tasks. Each guide covers a
+Concise walkthroughs for the most common `atomscale` tasks. Each guide covers a
 single workflow so you can jump straight to what you need.
 
 .. toctree::

docs/guides/inspect-results.rst

@@ -2,24 +2,24 @@ Inspect Analysis Results
 ========================
 
 ``general_use.ipynb`` demonstrates how to work with objects returned by
-:meth:`atomicds.client.Client.get`. This guide walks through the same workflow
+:meth:`atomscale.client.Client.get`. This guide walks through the same workflow
 in a linear format.
 
 Fetch analysed items
 --------------------
 
 .. code-block:: python
 
-   from atomicds.client import Client
+   from atomscale.client import Client
 
    client = Client(api_key="YOUR_API_KEY")
    search_results = client.search(keywords="demo", data_type="rheed_stationary")
 
    analysed = client.get(search_results["Data ID"].to_list())
 
 Each item in ``analysed`` is a subclass of
-:class:`atomicds.results.RHEEDVideoResult` or
-:class:`atomicds.results.RHEEDImageResult`, depending on the source data.
+:class:`atomscale.results.RHEEDVideoResult` or
+:class:`atomscale.results.RHEEDImageResult`, depending on the source data.
 
 Inspect time series data
 ------------------------

docs/guides/poll-timeseries.rst

@@ -3,7 +3,7 @@ Poll Time Series Updates
 
 ``timeseries_polling.ipynb`` shows how to stay current with streaming RHEED
 analysis. This guide summarises the four helper entry points in
-:mod:`atomicds.timeseries.polling` and explains which "mode" to pick:
+:mod:`atomscale.timeseries.polling` and explains which "mode" to pick:
 
 - **Manual loop** with :func:`iter_poll` – ideal for scripts that can block
   until each poll finishes.
@@ -19,8 +19,8 @@ Shared setup
 
 .. code-block:: python
 
-   from atomicds.client import Client
-   from atomicds.timeseries.polling import (
+   from atomscale.client import Client
+   from atomscale.timeseries.polling import (
        iter_poll,
        aiter_poll,
        start_polling_thread,

docs/guides/quickstart.rst

@@ -16,19 +16,19 @@ Install the client
 
 .. code-block:: bash
 
-   pip install atomicds
+   pip install atomscale
 
 Create a client
 ---------------
 
-The :class:`atomicds.client.Client` reads ``AS_API_KEY`` and
+The :class:`atomscale.client.Client` reads ``AS_API_KEY`` and
 ``AS_API_ENDPOINT`` from the environment. Export the variables, or pass values
 explicitly if you prefer.
 
 .. code-block:: python
 
    import os
-   from atomicds.client import Client
+   from atomscale.client import Client
 
    os.environ["AS_API_KEY"] = "YOUR_API_KEY"
 

docs/guides/search-data.rst

@@ -1,15 +1,15 @@
 Search the Catalogue
 ====================
 
-Use :meth:`atomicds.client.Client.search` to locate uploaded data. The examples
+Use :meth:`atomscale.client.Client.search` to locate uploaded data. The examples
 below mirror ``general_use.ipynb`` and add a few extra filters you can combine.
 
 Basic search
 ------------
 
 .. code-block:: python
 
-   from atomicds.client import Client
+   from atomscale.client import Client
 
    client = Client(api_key="YOUR_API_KEY")
 
@@ -64,5 +64,5 @@ upload timestamp, or last-accessed timestamp. Use ``None`` for an open bound.
 Next steps
 ----------
 
-Pass the ``Data ID`` column to :meth:`atomicds.client.Client.get` to fetch
+Pass the ``Data ID`` column to :meth:`atomscale.client.Client.get` to fetch
 analysis artefacts. See :doc:`inspect-results` for a hands-on tour.

docs/guides/stream-rheed.rst

@@ -2,7 +2,7 @@ Stream RHEED Video
 ==================
 
 ``rheed_streaming.ipynb`` demonstrates both push (callback) and pull (generator)
-streaming with :class:`atomicds.streaming.rheed_stream.RHEEDStreamer`. This
+streaming with :class:`atomscale.streaming.rheed_stream.RHEEDStreamer`. This
 guide condenses the notebook into a quick reference and explains when to choose
 each style:
 
@@ -23,7 +23,7 @@ Create a streamer
 
 .. code-block:: python
 
-   from atomicds.streaming.rheed_stream import RHEEDStreamer
+   from atomscale.streaming.rheed_stream import RHEEDStreamer
 
    streamer = RHEEDStreamer(api_key="YOUR_API_KEY")